API Blueprint で API 仕様書を書いて、配布用の HTML を自動生成する方法
（画像は API Blueprint の Web サイト より転載） GMO アドパートナーズ グループ CTO 室の M. Y.（DevOps ネタ担当）です。今回は、API 開発時に使って便利だったツールの話をします。 きっかけ 最近、私が担当している広告関係のプロダクトに、お客様向けに公開する API を新規追加することになりました。この API はお客様側のエンジニアが利用するため、API 仕様書を作る必要があります。 過去の社内事例では、Word ファイルで API 仕様書を作成して、配布していました。しかし、Word ファイルでは差分を確認しづらいので、API 仕様自体のバージョン管理が大変です。そこで、今回は API 仕様書から配布用の HTML を自動生成することにしました。 API 仕様書を自動生成する技術としては Swagger が有名ですが、今回のプロダクトでは AP
本当に使ってよかったOpenAPI (Swagger) ツール | フューチャー技術ブログ
サードパーティ製のツール本家からは上述のツールが提供されていますが、サードバーティ製の様々なツールが世の中には存在します。 エコシステムが成熟しているのもSwaggerを利用するメリットの一つですね。 https://openapi.tools/ 冒頭のとおり、このサードパーティ製のツールの中で実際に利用して良かったツールを3つご紹介したいと思います。 Stoplight Studiohttps://stoplight.io/studio/ 1つ目のツールは「Stoplight Studio」というAPI仕様を記載するためのGUIエディタとなります。 今までSwagger Editorを利用してYAMLを書いていたそこのみなさん、YAML筋力はもう必要ありません。 Design APIs 10x faster の謳い文句どおり、Stoplight Studioを使えばGUIで直感的に、高速
スキーマファースト開発のためのOpenAPI（Swagger）設計規約 | フューチャー技術ブログ
はじめまして。TIG DXユニット 1の亀井です。 はじめに みなさん、Swagger使ってますか？ Swaggerや周辺ツールについては 某先輩の記事 にて丁寧に解説されていますので、 本記事では実際にSwaggerのスキーマ定義を設計していく上で取り決めた規約について書いてみたいと思います。 前提私が在籍しているプロジェクトでは、REST APIは golang でフロントエンドを Vue.js + TypeScript で構築しています。 短期間・高品質での構築を実現するためにSwaggerを設計ドキュメントとしてだけではなく、コード自動生成やモックサーバーに活用させることで徹底したスキーマファーストな開発を行ってきました。 というわけで、今回は下記のツールを利用することを前提として規約を作成しています。 go-swagger: Goアプリケーションのハンドラ、リクエスト/レスポンス
Swaggerを使ってRestful APIを記述する - Goalist Developers Blog
こんにちは、ゴーリストのトゥアンです。 ウェブ開発でRestful APIはだんだん普及していると共に、Resful APIを記述するためにいろいろな仕方があります。 Swaggerを使うことは下記の通りに、いくつかの利点があります。 Amazon API Gatewayへ展開できる フロントエンド開発のため、モックサーバーを作りやすい OpenAPI仕様の基準に基づくAPIの入力（リクエスト）・出力(レスポンス)を定義できる Swagger 3.0 は2017年07月にリリースされましたが、現在AWSはSwagger 2.0だけサポートしているので、今回の記事でSwagger 2.0について説明します。 Swaggerファイルのフォーマット SwaggerでサポートしているフォーマットはYAMLとJSONです。 Swaggerファイルの構造は複数階層のオブジェクトです。ルートオブジェクト
Swagger UI × Amazon EC2 × Dockerで開発初期からAPIの繋ぎ込みを意識できる環境を構築してみた | GRIPHONE ENGINEER'S BLOG
Swagger UI × Amazon EC2 × Dockerで開発初期からAPIの繋ぎ込みを意識できる環境を構築してみた こんにちは！ PHP × Unityを使った新規開発プロジェクトでサーバサイドエンジニアをしている仙道です。 今回の記事ではSwagger UIとAmazon EC2、Dockerを使って開発初期から繋ぎこみを意識した開発を行うための取り組みを紹介したいと思います。 今回の記事ではAmazon EC2やDockerの基本的な使い方については触れないため、もしこれらについて分からないという場合は、下記のドキュメント等を参照いただければと思います。 Amazon EC2 : http://docs.aws.amazon.com/ja_jp/AWSEC2/latest/UserGuide/concepts.htmlDocker : https://docs.docker.
SwaggerでRESTful APIの管理を楽にする - Qiita
背景 最近は変化し続ける要件に対応するために、システムも柔軟であることが求められています。 そのため、部分的に変更やスケールの可能なシステムを構築し、API経由で連携するマイクロサービス的アーキテクチャが増えてきています。 そういった設計の中で問題になっていくのが、従来のモノリシックなアプリケーションではIDEやコンパイラなどで行っていた、機能間のインターフェイスをどう管理するかという部分です。 Swaggerとは? SwaggerとはRESTful APIのドキュメントや、サーバ、クライアントコード、エディタ、またそれらを扱うための仕様などを提供するフレームワークです。 公式サイトでは、The World's Most Popular Framework for APIsと謳っています。 その理由は、マイクロソフト、Google、IBM、SmartBearなどを大手の企業を含む「Open
Swagger-editorの使い方兼気になったこと覚書 - Qiita
初めに 仕事でSwagger-Editorを使うことになった。 んだが日本語のドキュメントが見当たらないので使い方兼覚書を作成。 使い始めて1週間もたってないので気づいたことがあったら順次更新していく所存。 ※後で清書する（とおもう） 英語でいいぞい、という人は↓とかで https://github.com/swagger-api/swagger-editor 環境構築 ↓をクリックすればswagger-editorが開く。楽。 http://editor.swagger.io/#/ Web上に会社のアレコレを書くのはちょっと…という人はDocker使うのが一番楽。 常に最新のバージョンが使えるのでいい感じ。 やることはDockerをターミナルで起動させた後、以下のコマンドをたたくだけ。 docker pull swaggerapi/swagger-editor docker run -p
開発効率を上げる！Swaggerで作るWEB APIモック - Qiita
みなさんは、開発初期の段階でWeb API(以下API)の実装が追いつかずクライアント側が開発できないという経験をしたことはありますか？ クライアント側はAPIがないと開発が滞ってしまうことがありますが、かといってAPIの開発も始まったばかりではすぐに必要なAPIを提供することができません。その問題を解決し、両者でスムーズに開発をすすめるために有効な方法の1つに、APIモックの作成があります。 弊社では、開発初期の段階でSwaggerとその周辺ツールを使ってWeb APIのモックを作成し、スムーズに開発できるようにしています。 Swaggerを使ったAPIモックの作成方法と手順、また気をつけるべき点などを紹介します。 目次 Swaggerとは？ Swagger記法の一例 Swaggerのエディター選択 SwaggerAPIモックの動かし方 結論 まとめ Swaggerとは？ Swagger
swaggerでAndroid向けAPIを作成するまでの流れ - Qiita
Mac+Docker環境にて、Android向けのクライアントAPIを作成するまでの手順や流れをまとめてみる。 Android側の仕様はRxJava&Retrofit2を使っていくスタイル。 前提としてDockerおよびMavenの環境と、Java7 or Java8がインストールされていること Swagger-Editorでyamlを作る 一番簡単な方法はここで編集する。 ただ、社内のAPIを外部のサイトに書くのはちょっと…という場合はDockerが用意されているのでそれを使うと良い DockerでSwagger-Editorを動かす Docker-Hubに上がっているので、それを持ってくるだけでよい。コマンドは以下のとおり(公式より) docker pull swaggerapi/swagger-editor docker run -p 80:8080 swaggerapi/swagg
goa のインストールと実行 - 押してダメならふて寝しろ
概要 goa は DSL で書かれた API デザインを goa のツールで変換してコードを生成します． そのコード生成ツールは goagen です．まずはこれをインストールして，実際に動かしてみるところまで説明します． 生成されるファイルとか，利用する API デザインについてはここでは触れませんが，おいおい説明していきたいと思います． 今回は，goagen のインストールと使い方の概要までです． インストール $ go install github.com/goadesign/goa/goagen でインストールできます．vendoring する場合は vendor フォルダに github.com/goadesign/goa を配置してください． vendor 以下の goagen フォルダまで降りていってビルドしておきます． $ cd ./vendor/github.com/goa
SwaggerでAPIを定義してインタラクティブAPIドキュメントを見る - Qiita
Swaggerを使ってAPI定義をしてスタブを動かしてみます。 Swaggerの関連ツールは様々な言語に対応していますが、ここではNode.jsを使って試してみます。 Swaggerとはなんぞ？ Swaggerは関連ツールが多くあるので全容がつかみにくいのですが、 What is Swagger? The goal of Swagger™ is to define a standard, language-agnostic interface to REST APIs which allows both humans and computers to discover and understand the capabilities of the service without access to source code, documentation, or through network
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
SwaggerHub | API Design & Documentation Tool
Swaggerでのapi開発よもやま話