REST API のドキュメンテーションはサービス開発における課題として認知されており、解決に向け近年さまざまな試みが行われています。OPEN API および Swagger はその有力な動きの1つです。 長いものには巻かれろ (?) ということで、今回は Swagger 定義ファイルをベースとした REST API ドキュメントの生成方法をまとめます。 結論 swagger2markup-cli と asciidoctor を組み合わせて HTML ファイルを生成するのがよさそうです。 課題の共有 Swggger 定義ファイルからドキュメントを生成する手順はいくつか存在します。 swagger-ui を利用する swagger-codegen で HTML を出力する swagger-ui はリッチで美しいドキュメントを提供してくれます。しかしインタラクティブな API ドキュメントが必
Swagger用ファイルを分割して記述しよう Swaggerとは Swaggerとは言語に依存しないREST APIのインターフェース仕様とそれに関連するツール/ライブラリのことです。 RESTful APIの記述標準化を目指している、MS/Google/IBMなどが参加しているグループ、 Open API Initiativeでは、APIの記述のためにSwaggerが採用されています。 Swaggerは以下のようなツールから構成されています。 Swagger UI - swagger specをパースしてAPIドキュメント化するツール Swagger Codegen - swaggerの定義ファイルからプログラムコードを生成するツール Swagger Editor - オンラインで使用できるSwaggerエディタ 普通にswaggerの記述をする まずは下記のように、普通にswagger
以前 ゴールを決め目標を決める・解決案ではなく質問する - コーチングの学習で学んだこと - $shibayu36->blog; で、「ゴールを決め、現在位置とのギャップを考え、目標を決める」と良いということをまとめた。イメージとしては以下の図の通り。 しかし、前回の記事だと具体的にどのようにエンジニアの目標設定を行うかイメージが湧かない。そこで、もう少し具体的に最近どのようにやっていたかを書いてみたいと思う。 僕がメンティーと目標設定を行うときは、以下のフローを辿っている。 なんでも良いのでゴールのイメージを明確にする 現在の自分とゴールのイメージのギャップを考える ギャップを埋める目標を考え、アクションを定める ちなみに今回は、チームの成果達成のために個人の目標を決めるのではなく、エンジニアのスキル向上の目標を立てるという前提で書いていく。 なんでも良いのでゴールのイメージを明確にする
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
