API Blueprint で Web API の仕様を書く - CUBE SUGAR CONTAINER
Web API のドキュメンテーションって結構めんどくさい。 どういうフォーマットで書くか悩むし、書いていくと似たような内容を何回も繰り返すことになる。 ドキュメントとは別に開発用のモックも用意しなきゃいけなくて、それとの整合性が…ってな具合に悩みは尽きない。 そんなとき今回紹介する API Blueprint を使うとそういった悩みを減らすことができるかもしれない。 今回使う環境は次の通り。 $ sw_vers ProductName: Mac OS X ProductVersion: 10.11.3 BuildVersion: 15D21 API Blueprint API Blueprint というのは Web API (特に RESTful API) の仕様を記述するための言語仕様を指している。 ただし、これは単なる Markdown で書かれた文章を Web API の仕様書とし
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
API Blueprint で API 仕様書を書いて、配布用の HTML を自動生成する方法
（画像は API Blueprint の Web サイト より転載） GMO アドパートナーズ グループ CTO 室の M. Y.（DevOps ネタ担当）です。今回は、API 開発時に使って便利だったツールの話をします。 きっかけ 最近、私が担当している広告関係のプロダクトに、お客様向けに公開する API を新規追加することになりました。この API はお客様側のエンジニアが利用するため、API 仕様書を作る必要があります。 過去の社内事例では、Word ファイルで API 仕様書を作成して、配布していました。しかし、Word ファイルでは差分を確認しづらいので、API 仕様自体のバージョン管理が大変です。そこで、今回は API 仕様書から配布用の HTML を自動生成することにしました。 API 仕様書を自動生成する技術としては Swagger が有名ですが、今回のプロダクトでは AP
API Blueprintとその周辺ツール - Qiita
APIを作る機会が増えてきている 例えばマイクロサービス間はAPIでやりとりすることが多い。 外部のサービスもだいたいAPIでやりとりする。 社内APIもいくつかあるが、いざ使おうとなるとどんなリクエストを送るべきなのか、またどんなリクエストが返ってくるのかを調べるのが面倒。 API ドキュメントを書くのは大変 フォーマットは？ Markdown? HTML? Text? エンジニア間で書き方がバラバラにならない？ そのドキュメントの内容は今も正しい？ そもそも書くのが面倒… ということで、いい感じのAPIドキュメントツールがほしい API ドキュメントツールに求めること その1 ドキュメントが書きやすい ドキュメントが読みやすい ドキュメントがGitで管理しやすい リクエスト情報、レスポンス情報が見やすい curlですぐに試せるようにサンプルがほしい ドキュメントとコードに乖離がないよう
[サーバー] API Blueprintで、ライブリロードでドキュメントを書く、ファイルを分割してドキュメントを書く - YoheiM .NET
[サーバー] API Blueprintで、ライブリロードでドキュメントを書く、ファイルを分割してドキュメントを書く こんにちは、@yoheiMuneです。 サーバーサイドとフロントエンドで別々の人が開発する場合、APIドキュメントが必要なことが多いです。APIドキュメントの作り方は色々とありますが、API Blueprintが人気のツールの1つです。最近それを使い始めたので、本格的に書くためのセットアップをブログに書きたいと思います。 目次 API Blueprintとは API Blueprintは、APIドキュメントを書くためのツールです。サンプルを少しずつ変更していくことで、すぐにドキュメントを書くこともできます。 例えば以下の記述をすると、 # Group カテゴリー（公開API） ## カテゴリーのエンドポイント [/api/categories] ### 一覧の取得 [GET
![[サーバー] API Blueprintで、ライブリロードでドキュメントを書く、ファイルを分割してドキュメントを書く - YoheiM .NET](https://cdn-ak-scissors.b.st-hatena.com/image/square/5f5d3c76fb686830cd12474bb84c886040a9cacd/height=288;version=1;width=512/https%3A%2F%2Fwww.yoheim.net%2Fimage%2F584.jpg)
api blueprintとaglioを利用してAPI仕様書を作成する - Qiita
概要 Web APIの開発をするのにとりあえずモックを作成してフロントエンドからアクセスできるようにしたくて、どうしようかなと悩んでたらAPI Blueprintなるものを知ったので、試してみました。 今回はAPIドキュメントを手間なくまとめるツールのご紹介です。 api blueprint https://apiblueprint.org/ こちらの記事を参考にさせてもらいました。感謝！ API BlueprintとdrakovとdreddでAPIドキュメントを書きつつモックサーバを立ててさらにテストを走らせる https://arata.hatenadiary.com/entry/2018/03/22/204723 今回構築した環境をGitHubにUPしていますので、ご参考ください。 https://github.com/kai-kou/api-blueprint-use-aglio
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Moved
https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md