"api blueprint"の検索結果1 - 2 件 / 2件

• あとで読む

  API Blueprintで仕様書を作成しつつモックサーバも起動する手順 | MONSTER DIVE

  • 6 users
  • www.monster-dive.com
  • テクノロジー
  • 2020/01/25

  Webでも組み込みでも、何かのシステムを構築したことがある方ならご存知でしょう。 開発というものは、「プログラムを書く作業」よりも、その前の「仕様を決めて文書化する作業」の方がずっとカロリーが高いものです。 最近ちょっとしたAPIを作る機会があり、やはりAPI仕様設計のしんどさと闘いました。 が、API Blueprintという規格とそれに対応するツールを使うことで、そのしんどさが相当な具合で和らぐことがわかりました。 今回はこのAPI Blueprintを全力で推していく記事です。 API Blueprintとは？ https://apiblueprint.org/ API Blueprintは、APIの仕様設計や連携開発を効率的に進めるためのドキュメント仕様です。 Markdownに従った仕様になっているので、そのまま眺めてもある程度理解できるのですが、Blueprintの強みはなんと

  • プログラミング

  
• あとで読む

  API Blueprintのススメ - Qiita

  • 3 users
  • qiita.com/oskamathis
  • テクノロジー
  • 2020/03/18

  はじめに 最近WebAPIを触る機会があって懐かしくなったので、以前とある案件でかじったAPI Blueprintでも布教してみます。 APIの仕様をMarkdown拡張記法で記述できる言語です。 慣れるまでは正直書きづらいですが、元がMarkdownなのでSwaggerに比べるとまだ書きやすい方だと思います。 今度記事にしますが、先日Frisby.jsというWebAPIのテスティングフレームワークを触るためにJWT認証を使った簡単なWebAPIを作ったので、サンプルとしてAPI Blueprintで仕様書を書いてみました。 FORMAT: 1A HOST: http://localhost/api # Sample API Frisbyを触ってみるために最低限の機能だけで作ったWebAPI ## ユーザ登録 [POST /users] 新規ユーザを登録する + Request (appl

  • Qiita
  • API