スキーマファースト開発のためのOpenAPI（Swagger）設計規約 | フューチャー技術ブログ
はじめまして。TIG DXユニット 1の亀井です。 はじめに みなさん、Swagger使ってますか？ Swaggerや周辺ツールについては 某先輩の記事 にて丁寧に解説されていますので、 本記事では実際にSwaggerのスキーマ定義を設計していく上で取り決めた規約について書いてみたいと思います。 前提私が在籍しているプロジェクトでは、REST APIは golang でフロントエンドを Vue.js + TypeScript で構築しています。 短期間・高品質での構築を実現するためにSwaggerを設計ドキュメントとしてだけではなく、コード自動生成やモックサーバーに活用させることで徹底したスキーマファーストな開発を行ってきました。 というわけで、今回は下記のツールを利用することを前提として規約を作成しています。 go-swagger: Goアプリケーションのハンドラ、リクエスト/レスポンス
OpenAPI関連のサイト・ツールまとめ | GiFT（ギフト）株式会社
OpenAPI関連のサイト・ツールまとめ2020.10.29 OpenAPI関連のサイトやツールなどの情報が種々雑多にあるので、自分の中での整理と忘備録として残すためにまとめました。（2020年10月時点） 概要OpenAPIとはOpenAPIという表現が使われた場合、恐らくそれらの多くはOpenAPI Specification（以下OAS）に基づいてJSONやYAMLで記述されたREST APIの仕様書（スキーマ）を指しているように思います。 OASはREST APIの仕様を記述するための規格であり、それ自体がなにかのツールやサービスを提供するものではありません。 とはいえ関連するツールやサービスも普及してきているので、あまり言葉の意味を気にしすぎる必要もないかもしれませんが。 OpenAPI Specification (v3.0.3)Implementer’s Draft (OAS
今から Rails 6.x アプリケーションをつくるなら入れておきたい Gem やテクニック | 2020年10月版
2022/1/31 追記 いまだにこの記事のPVがあるので Rails アプリケーション作るときに参考になりそうなリンクを追記しておきます。 【Rails】もっと早く知りたかったデバッグ用gem 'better_errors','binding_of_caller' | Qiita https://qiita.com/terufumi1122/items/a6f9a939dce25b2d9a3e 【Rails】better_errorsとbinding_of_callerで自分でエラーを解決できるようになろう【初心者向け】 | Qiita - https://qiita.com/ryokky59/items/284892be879996e4f77c Railsにおけるドメイン駆動設計の実践 | linyclar - https://linyclar.github.io/software_d
PHPで新しくAPIサーバーを建てるまで - 開発のススメ方や利用している技術スタックなど - WebエンジニアのLoL日記
はじめに 新しくAPIサーバーを建てるまでの話 新サービスを建てるにあたり考えなければいけないこと 開発を進めるにあたり 言語・フレームワーク・ミドルウェア選定 フレームワークどうするか GraphQLを採用するか、JSONのREST APIにするか サーバー構成をどうするか 構成管理（Infrastructure as a Code） ローカル開発環境はどうするのか CI環境を用意しておくことは重要 コーディング規約や各種規約はどうするのか API仕様作成時の方針について 各環境へのデプロイはどうするのか DDoSやSQLインジェクション対策はどうするのか DDoS対策 CORS, CSRF ミドルウェアの脆弱性 フェイルオーバーの仕組みをどうするか APIサーバーが1台落ちたときに利用者に影響が出ないか 接続先のDBが落ちた時に影響が出ないか サーバー（サービス）監視 ドキュメントをS
【API】【Swagger】Swaggerをモックサーバとして機能させるまで - Laravel・PHP入門
今回、サーバ・フロントの完全分業実現のため Swaggerを導入し、APIの仕様を管理、かつモックサーバとして機能させることに。 仕様を決める→モックサーバとして動作させるまでの流れメモ。 動作確認環境 流れ 前準備(brew/npmは入ってる前提) swagger形式のAPI仕様書作成 動作確認環境 Mac OS X以上 Swagger2.0 (Open APIは3.0が最新ですがswagger-codegen使用のため2.0を使用) はやく3.0対応してほしみ。。。 流れ ※色々インストールなどの前準備※ ①API仕様をSwagger形式(yaml)で記載、 ②Swagger-Codegenを使用してnode.jsのプロジェクトへ変換 ③サーバ起動 →モックサーバとしてブラウザ上での確認、 自分のプロジェクトからもレスポンス確認ができる 良いこと： * Githubでyamlファイルの
OpenAPI Generator - community drivenで成長するコードジェネレータ - 暁
2018-05-12、OpenAPI Generator が公開されました。 https://github.com/OpenAPITools/openapi-generator OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec これは Swagger Codegen v2.4をフォークしたプロジェクトで、OpenAPIドキュメントから様々なプログラミング言語のAPIクライアントやスタブサーバーなどのソースコードを生成するツールです。まだベータ版のような状態で、“v3.0.0”として初回リリースすることを予定しています 。 私
OpenAPI GeneratorでRESTful APIの定義書から色々自動生成する #OpenAPI - こまぶろ
APIの定義を書く：Excel仕様書はもういやだ RESTful APIを提供するサーバと、そのAPIを利用するクライアント（たとえばSPA）とを並行で開発しようとするとき、まずAPIを定義して、それに基づいてサーバ／クライアント双方の実装を進めようと考えるのは自然だと思う。 そうと決まれば、「API仕様書_20190110.xlsx」と題するファイルを新規作成し、シート別にリソース毎の定義を書き始め・・・てはいけない。せっかくAPIを定義したドキュメントを作成するなら、するのなら、ソースコードの自動生成などの恩恵も受けたい。受けられるはずだ。 少しググってみる。どうやらSwaggerというものを使えばいいらしい。Swaggerに興味を持ったタイミングで、ちょうど書店に平積みになっていた『WEB+DB PRESS Vol.108』の表紙が目に入った。そこには、「スキーマ駆動Web API開
開発効率を上げる！Swaggerで作るWEB APIモック - Qiita
みなさんは、開発初期の段階でWeb API(以下API)の実装が追いつかずクライアント側が開発できないという経験をしたことはありますか？ クライアント側はAPIがないと開発が滞ってしまうことがありますが、かといってAPIの開発も始まったばかりではすぐに必要なAPIを提供することができません。その問題を解決し、両者でスムーズに開発をすすめるために有効な方法の1つに、APIモックの作成があります。 弊社では、開発初期の段階でSwaggerとその周辺ツールを使ってWeb APIのモックを作成し、スムーズに開発できるようにしています。 Swaggerを使ったAPIモックの作成方法と手順、また気をつけるべき点などを紹介します。 目次 Swaggerとは？ Swagger記法の一例 Swaggerのエディター選択 SwaggerAPIモックの動かし方 結論 まとめ Swaggerとは？ Swagger
PHP環境にSwagger導入 - Qiita
Swaggerとは Swaggerは言語に依存しないREST APIのインターフェース仕様とそのツール群を指す。 Swaggerの仕様に沿ってAPIを定義することで、人間が理解可能で、コンピューターにも解析可能なAPI仕様書となる。 引用：http://d.hatena.ne.jp/takeR/20151207/1449469957 らしいです。 ともあれ導入 環境 CentOS 6.5 x86_64 PHP環境（PHP5.5、Nginx1.8） CodeIgniter3.0.6 composerインストール $ curl -sS https://getcomposer.org/installer | php All settings correct for using Composer Downloading 1.0.0... Composer successfully installe
Swagger-PHPについてLaravel 5.2で確認したメモ - hrendoh's tech memo
SwaggerのPHP実装であるSwagger-PHPの使い方についてLaravelプロジェクトで確認し、Swaggerとはどんなものか調査したメモになります。 Swaggerの全体像については、「RESTful APIの記述標準化を担うSwaggerとは？ | NTT Communications Developer Portal」が参考になりました。 Swaggerを利用したアプリケーション開発は、まずSwaggerドキュメントを作成して、サーバーのスタブとクライアントライブラリを生成し、APIロジックとクライアントUIなどを実装していくような流れになるといったところのようです。 Laravelはありませんが、コード生成ツール swagger-codegen には、Laravelの軽量版であるLumen用のサーバースタブは生成可能です。 この記事では、Laravel 5.2プロジェクト
Dockerを使ってswagger.yamlをサクッとみる (swagger-ui 3.x) - Qiita
swagger-uiの3.xが出ました 個人的に大きく変わったなと思うポイントは、以下の二点です。 YAMLの読み込みがサポートされた swaggerのspecの書式はJSONとYAMLの２種類が用意されているのですが、swagger-ui 2.xではJSONしかサポートされていなかったので、YAMLをJSONに変換して読み込ませる必要がありました 見た目がガッツリ変わった deprecatedとかが地味だったのがわかりやすく表現される様になりました ローカルで動かすのが楽になった 以前こんな記事を書きました。 SwaggerでAPIを定義してインタラクティブAPIドキュメントを見る Dockerを使ってswagger.yamlをサクッとみる このときに比べてswagger周辺のツール群も洗練されてきたので、それに合わせてさくっと見る方法の最新版を書きます。 公式Dockerイメージが有る
Swagger EditorとSwagger UIとSwaggerのモックAPIサーバーをdocker-compose化してみた - Qiita
Swagger EditorとSwagger UIとSwaggerのモックAPIサーバーをdocker-compose化してみたswaggerdocker-composeSwagger-editorswagger-uiOpenAPI 背景 初投稿です。イレブンナインの松田です。@matsudachikara2 最近、社内でAPIの仕様をどうやって管理、共有していくかを検討してました。そこで、Swaggerを使うのがいい感じらしい！ということを聞き、調査を始めましたが、個々のツールの使い方や導入は出てくるものの、具体的にチームで共有、管理まではどうやってするのかいまいち分かりませんでした。 調べていくとSwaggerHubなどのプラットフォームを使うのが一般的みたいでしたが、もっと簡単にSwagger EditorとSwagger UIとSwaggerのモックAPIサーバーを使えたらなという
Swaggerを使ってAPI仕様を共有する - Qiita
要約 swaggerの説明 使い方 背景 クライアントとサーバーの実装者が分かれていて情報共有に時間がかかる状況です。 事前にAPIの仕様だけは固めて共有しておきたいです。 ただ、手書きのドキュメントの場合は曖昧な表現が残り、誤解が生じる可能性があります。 ドキュメントのバリデーションができると嬉しいです。 欲を言えば、仕様の動作を確認するためのスタブサーバが作れると嬉しいです1。 そこでswaggerを使います。 swaggerとは？ SwaggerはWeb APIのドキュメンテーション仕様と、それを作る・使うツール群です。 ドキュメンテーション仕様 最新のドキュメンテーション仕様はOpenAPI 3.0です。 ツール群の対応が終わっていません。 現時点では、前身のSwagger 2.0を使います。 Swagger Editor Swagger Editor はSwagger 2.0を編
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Swagger 3.0 入門(1) Swagger(OAS) 3.0の登場
https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/php-laravel.md
https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/spring.md
GitHub - OpenAPITools/openapi-generator: OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
GitHub - elevennines-inc/swagger-all-in-one-docker-compose
Swaggerは使える - Qiita
OpenAPI (Swagger) 超入門 - Qiita
