prmd を利用して JSON Schema を簡単に管理しよう - Qiita
JSON Schema ってどこにどうやって置いて管理したらいいの？ prmd の README にある File Layout の項で、JSON Schema のオススメのファイル構成について言及されていたので、積極的に真似していくスタイルがヨサソウです。 /docs # top-level directory for project documentation /schema # API schema documentation /schemata /{resource.[json,yml]} # individual resource schema /meta.[json,yml] # overall API metadata /overview.md # preamble for generated API docs /schema.json # complete generate
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
The Heroku HTTP API Toolchain
Today we’re open sourcing the toolchain Heroku uses to design, document, and consume our HTTP APIs. We hope this shows how Heroku thinks about APIs and gives you new tools to create your own. This toolchain includes: An HTTP API design guide, describing how we structure both internal and public-facing APIs and document them using the JSON Schema standard. A tool for working with JSON schemas and u
JSON Hyper-Schema からAPIドキュメントとGoのコードを自動生成する | The Wacul Blog
３行で言うと herokuが作ってる prmd を使って、JSON SchemaからAPIドキュメントを出力したよ！ スキーマ定義から、GoのAPI実装コードも出力するツールを作ったらめっちゃ捗るよ！ Goのバリデーション用のライブラリも作ったよ！ 今回作ったものの概要とサンプルコード 概要 以前から、APIを開発する上で、以下のようなことが課題となっていました。 そもそもドキュメント書くのがつらい それもあって、ドキュメントより先にコードが変わってしまう ドキュメントと実装の状況の違いが把握しづらい また、ロジックがそんなに複雑ではないAPIでは、実装の作業は リクエストデータのバリデーション 出力データの整形 (フィルタリング) の２つの作業が大きな割合を占めます。 APIの定義ファイルからドキュメントと、バリデーションや出力データ整形のコードを自動生成できれば、大幅に効率が上がると思
JSON Schemaを上手く運用出来そうなprmdとその周りのお話 - Qiita
最近APIのバリデーションを行うのにJSON Schemaを使おうという話をよく聞くのですが じゃあやってみようとすると、単体のJSONのバリデーションを行うことは出来るけれど それが実際の運用に適用できるようにするためには、 それなりに考えなくてはいけないようです。 JSON Schemaって? JSON Schemaは、文字の通りJSONのスキーマ定義を明確にするものです。 2014/09/07現在、IETFにdraft v4が3つに分割されて公開されています。 JSON Schema Core JSON Schema Validation JSON Hyper-Schema それで、単体のJSONファイルの確認ならばCoreだけで十分なのですが WebサービスのAPIを管理しようとなると、 JSON Hyper-Schemaのほうで定義されているlinksを使って、ひとつのURIに対
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
SSSSLIDE
GitHub - interagent/prmd: JSON Schema tools and doc generation for HTTP APIs
