JSONスキーマからGo言語コードを作成して利用してみる
プログラミング (iOS, JavaScript, Jenkins, Sikuli) とMacやiPhoneなどの話題が中心のブログ JSONスキーマにサーバ側APIについての記述を書けたり、ソースコードが生成できたりするので、いろいろ試してみました。 今回行ったことは次の通りです。 IIJmioクーポンスイッチAPIのドキュメントを参考に、JSONスキーマを勝手に書いた JSONスキーマ用のツールprmdでAPIドキュメントを作成したり、スキーマの検証を行った JSONスキーマ用からGo言語のクライアントコードを生成するツールschematicでコードを生成して、それを使った prmdを導入する とりあえず、JSONスキーマ用のツールprmdを導入しておきます。gemで一発です。 $ sudo gem install prmd JSONスキーマを記述する IIJmioクーポンスイッチAP
Documenting the JSON Schema of your Rest APIs
Recently at work I have been looking at how to document our Restful APIs. After a chat with a couple of developers we had defined the following requirements we wanted from our restful API documentation: We needed to be able to document the URIs, HTTP methods, querystring parameters. We wanted to be able to specify a bit of descriptive text associated with each API call. A tool embedded in the docs
全てがJSONになる - ✘╹◡╹✘
TL;DR JSON Schemaを使ってこういうことが実現可能になった。 ダミーAPIサーバの提供 ドキュメントの自動生成 APIクライアントの動的定義 APIサーバのバリデータの動的定義 APIサーバのレスポンスの自動テスト JSON Schemaとは JSON SchemaというのはあるJSONのデータ構造を記述するための方法および書式の仕様で、 JSON SchemaもJSONで記述される。 これを利用すれば、リソースベースの(=RESTfulライクな)APIの仕様が簡便に記述できる。 例えば、我々のAPIはレシピとユーザというリソースを扱っていて、 それぞれCRUDのAPIを備えており、レシピはidとtitleとdescriptionという属性を持つ、 という旨をJSON Schemaで表現できる。 なんで最近ちょっと流行ってんの Mobile First、 Service Or
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
GitHub - interagent/prmd: JSON Schema tools and doc generation for HTTP APIs
GitHub - r7kamura/jdoc: Generate API documentation from JSON Schema.
Redirecting to https://json-schema.org/understanding-json-schema/index.html
