タグ

ブックマーク / blog.hde.co.jp (1)

  • APIの仕様をMarkdownで定義する - HDE BLOG

    おはこんばんちは!! 尾藤 a.k.a. BTO です。 Web APIの仕様の定義ってみなさんどうされているでしょうか。 人によって書き方がバラバラだったり、定義に過不足があったりしてないでしょうか。 Web APIのインターフェースで定義する内容は、ほとんど決まってます。 もっと形式的な書き方できないだろうかと探してみたら、やはり同じ事を考えている人がいて、API Blueprintというのを見つけました。 API Blueprint - API Documentation with powerful tooling API Blueprintを使うとMarkdownAPIの定義ができます。 できること APIの記述フォーマットが決まっていますので、どこで何が定義されているかが分かります。 ですので、機械的に処理する事ができるようになります。 具体的には、 APIドキュメントの生成

    APIの仕様をMarkdownで定義する - HDE BLOG
  • 1