OpenAPI (Swagger) まとめ - Qiita
はじめに 自分は実務でReact×TypeScriptを利用したフロント周りとNode.js(Nest)やRailsを用いたバックエンド(API)の開発をしています。 本記事では、OpenAPIを用いたAPI設計の書き方及び、Swaggerの説明と使い方についてまとめていきます。 この記事の対象者 プログラミング初心者から中級者 APIの基礎を理解している人 OpenAPIを用いてサクッとモックサーバーを試したい人 この記事の目標 モックサーバーの環境構築を学ぶ Swaggerの使い方を理解する OpenAPIを用いてAPI設計の具体的な書き方を学ぶ この記事でやらないこと 本記事ではOpenAPIの「書き方」をメインで解説するため、API設計についての細かい解説は省きます。 なおAPI設計については下記の記事でまとめているので、ぜひ参考にしてみてください。 用語解説 OpenAPI 公式
go-swaggerで作るAPIサーバー｜レスキューナウ（24時間365日 災害･危機対応をサポート）
こんにちは。株式会社レスキューナウの新プロダクトチームで主にバックエンドを担当している本田です。 現在、バックエンドではGo言語を採用し、go-swaggerというswaggerからGoコードを自動生成してくれるライブラリを使って、各APIを開発しています。 同じようなライブラリにopenapi-generatorというのもあります。 今回はこのgo-swaggerを使って実際に簡単なAPIを実装してみてみます。 go-swaggerインストールまずはgo-swaggerをインストールしていきます。 Macの場合はHomebrewでインストールできます。 もちろん go install や他のインストール方法もあります。 $ brew tap go-swagger/go-swagger $ brew install go-swaggerディレクトリ作成次にプロジェクト用のディレクトリの作成
本当に使ってよかった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で直感的に、高速
go-swaggerを用いたWebアプリケーション開発Tips19選 | フューチャー技術ブログ
はじめにTIG DXユニット 1の真野です。echo → 生net/http → gorilla/mux → go-swagger, gqlgenの経歴でGoのHTTP APIを実装してきました。本記事では最近業務でヘビーユーズしているgo-swaggerについての開発Tipsをまとめました。 背景フューチャーではGoを採用する案件が増えて来ており、その際にgo-swagger というツールを利用することが多いです。 2 理由はWebAPIのスキーマを駆動に開発することに慣れているという開発文化（DBレイヤのERDやデータフローを駆動に開発することは今も多い）や、リリース後の保守や将来のマイグレーションを考慮しなるべく特定のDSLに依存したくないというポリシーを強く持つこと、開発前にある程度固く機能数を洗い出して工数見積もりや開発スケジュールに活かしたいといった大人な事情など、色々相性が良
GO/Gin gin-swagger使用してAPI仕様書を生成します - Qiita
package main import ( "github.com/gin-gonic/gin" swaggerFiles "github.com/swaggo/files" "github.com/swaggo/gin-swagger" "net/http" _ "use_swagger/docs" ) // @title APIドキュメントのタイトル // @version バージョン(1.0) // @description 仕様書に関する内容説明 // @termsOfService 仕様書使用する際の注意事項 // @contact.name APIサポーター // @contact.url http://www.swagger.io/support // @contact.email support@swagger.io // @license.name ライセンス(必須) /
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
