https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md
API BlueprintでWebAPI仕様書を書く | SG Labs
WebAPIを開発する場合、APIの利用者向けにAPI仕様書を書くと思います。 API BlueprintというWebAPI仕様書のためのMarkdown記法を拡張した記法があり、これに則って仕様書を書くとスムーズに書くことができます。 今回は、このAPI Blueprintに則ってWebAPI仕様書を書く際のちょっとしたTipsを書いてみます。 前提 ここでは、 API Blueprint形式のドキュメントをテキストエディタで書く。 ドキュメントは、aglioを使ってHTML化する。 を前提としています。 API Blueprint API Blueprintは、公式サイトに、 A powerful high-level API description language for web APIs. とあるように、API仕様書を書くための記法です。 API Blueprintの記法の詳細に
Apiドキュメンテーションツールを使いこなす【api blueprint編】
12. Api Blueprintとは 公式(https://apiblueprint.org/) 「A powerful high-level API description language for web APIs」 APIドキュメントの記述に特化した言語 拡張子は.apibだが、.mdのほうが便利なことが多い syntax highlightingが効く Markdown previewが効く(特にgithub) .mdで困ることは殆どないので、個人的にはこちらを推奨 13. Api Blueprint vs Swagger Github (https://github.com/apiaryio/api-blueprint) Star数は5,539 (資料作成時) Swaggerツール群(https://github.com/swagger-api) と比べると Swagger S
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
