はじめに 私の職場では、WebAPIの仕様書をWordで書く習慣があったのですが、2018年頃にSwaggerで書くように切り替わったので、そのように変化した経緯を書きます。 何かの参考になれば幸いです。 ちなみに、こちらの記事と同じ職場です。 Wordな職場にMarkdownを定着させるためにやった４つのこと Swaggerとは？ Swaggerとは、REST APIの仕様を定義するためのフォーマットです。その周辺技術も含めて、Swaggerと呼ばれます。以下の記事が非常に参考になりますので、詳細を知りたい方はご参照ください。 Swaggerの概要をまとめてみた。 Swagger 導入失敗 2016年頃のある日、上司から「世の中にはSwaggerというものがあるらしい。調べてもらえる？」と指示されました。 調べてみたところ、Swaggerがあれば、WebAPIのドキュメントサイトも作れる
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 ライセンス(必須) /
APIの設計とWeb上への公開までをシュッとできる基盤をdockerで構築したのでシェアします。 SwaggerについてOpenAPIのフォーマットに準拠したAPI仕様を定義できるツールです。 OpenAPIに従って認証部分やリクエスト、レスポンス形式などを具体的に整理できるので、draw.ioなどの描画ツールでは気づかない部分や漏れを防げます。 Swaggerの実態は静的コンテンツなので、GitHub PagesやAWS S3などにポンと置いて公開できます。 取り急ぎSwaggerを試したい場合はdocker Hubにimageがあるので、下記コマンドでささっと利用可能です。 docker pull swaggerapi/swagger-editor docker run -d -p 80:8080 swaggerapi/swagger-editor Swaggerの利用基盤構築取り急ぎ
+ handler = middleware.SwaggerUI(middleware.SwaggerUIOpts{}, handler) log.Fatal(http.ListenAndServe(":8080", handler)) このようにハンドラーに適用するだけで /docs で Swagger UI を提供することができます。 このミドルウェアは html/template で生成した自前の HTML を返すのですが、その HTML は UNPKG のアセットを参照する形になっています。デフォルトは最新バージョンを参照するようになっているので更新作業なども不要です。 ミドルウェアにはオプションが用意されているので、アセットのバージョンを固定したり HTML のパスを /docs から変更することもできます。 // SwaggerUIOpts configures the Swa
概要 下記のように１つのサービスで複数のAPIが存在する場合、 定義書(yamlファイル)を１つのSwagger-UIで扱えないか調べたのでメモする。 例) サンプル ・① サービス運営API ※ サービス運営側のスタッフがアクセスする管理用のAPI ・② 企業管理API ※ 契約企業のスタッフがアクセスする管理用のAPI ・③ 店舗管理API ※ 契約企業の各店舗のスタッフがアクセスする管理用のAPI ・④ フロントAPI ※ 一般ユーザーがアクセスするホームページやアプリ用のAPI version: '3' services: # Swagger (API仕様書) swagger-company: image: swaggerapi/swagger-ui volumes: - ./service.yaml:/usr/share/nginx/html/service.yaml # サービ
StoplightStudio + openapi2aspida + SwaggerでAPIクライアント自動生成とモックサーバー起動
この課題に取り組んだ背景 現在、弊社の自社開発でよく多様しているのが、フロントエンドはReact、バックエンドはnodejsを使用しREST API + SPAの構成でシステムを開発しています。 その際、フロントエンドとバックエンドでエンジニアがそれぞれいるのですが、同時に開発を進めようとすると、API仕様の認識のずれや、サーバーが開発途中だとフロント側のデータ取得・表示部分をどうしようかなどで悩むことがあります。 そこで今回はAPIの仕様書を簡単に作成できるSwaggerを使用し、そこから更にモックサーバーまで建てて、開発効率を上げていきたいと思います。 今回使用した技術・ツールたちの紹介 名前 用途
Swaggerを導入したきっかけ弊社では、2018年頃から「WebのサーバーサイドはAPIとして機能提供」スタイルが中心となってきました。 API開発ではページ組み込み系と比べ、データのIN/OUT設計をよりしっかりと行う必要があります。APIという事で、IN/OUTが剥き出し状態になるので、当然といえば当然です。 それほど重要なAPIのIN/OUT定義、仕様設計については、ドキュメント形式について色々と悶着がありました。 結果、弊社では「Swagger」(またはOpenAPI)をメイン仕様書として使うスタイルで落ち着いています。 Swaggerを運用してわかった良かったこと・悪かったことSwagger、本当に便利ですね！大変快適です。 Excelで管理しようとしていた時代から比べると開発がしやすくて仕方ありません。 とはいえ悪かったこともあります。Swaggerを仕様書のメインに据えてA
【Unity】OpenAPI(Swagger)からopenapi-generator-cliを使用してコードを自動生成する Swaggerで定義したAPI仕様書から型や、API Request処理をUnity（C#）に自動生成する手順を備忘録として記載します。 環境 OS : Mac(M1) 14.3.1 Unity : 2022.3.9f1 Swagger準備 まず、サンプルとして下記のようにopenapi.yamlを作成します。 openapi: "3.0.3" info: title: "Sample API" version: "1.0.0" paths: /api/v1/hello-world: get: summary: "hello world" responses: 200: description: "success" content: application/json:
SwaggerでLambdaのデバッグ環境を作る(6)：GCPのCloud Endpointsをデバッグする - Qiita
第1回投稿で、SwaggerでLambdaのデバッグ環境を作りました。 SwaggerでLambdaのデバッグ環境を作る(1) 今回は、Google Cloud Platform(以降GCP)のCloudEndpointsをデバッグします。 GCPへの設定は、以下に書いてある手順に従って進めます。 https://cloud.google.com/endpoints/docs/openapi/get-started-app-engine?hl=ja ですが、GCPのCloudEndpointsをデバッグするのではなく、Swagger定義ファイルを使って動作していたLambdaのNode.jsのコードを、CloudEndpointsに移設するイメージです。 CloudEndpointsは、Swagger定義ファイル(別名OpenAPI)に基づいて動作します。 したがって、これまでSwagge
OpenAPI (Swagger) 形式のyamlからrequestBody/responsesのサンプルJSONを出力する - Qiita
OpenAPI (Swagger) 形式のyamlからrequestBody/responsesのサンプルJSONを出力するNode.jsJSONYAMLswaggerOpenAPI はじめに ユニットテストとかを書くためにAPIのリクエストとレスポンスがJSON形式で欲しいとなったときに、今まではOpenAPIドキュメントをReDocで表示してそこに載っているサンプルをコピー＆JSON形式で保存し直すみたいなことをしていました。 ただしこの方法は、APIの数が増えてきてかつ変更もちょくちょくあるような場合だと結構面倒な作業ですし、CIにも組み込みにくいです。 わざわざこの画面を経由しないでもOpenAPIドキュメントのyamlからこのrequestBody/responsesだけを直接JSONで吐き出す方法は何か無いものかと色々調べてみたのですが、元のOpenAPIドキュメントをyaml
Azure Functions の分離ワーカーモデルで OpenAPI/Swagger を使う - Qiita
やりたいこと Azure Functions の分離ワーカーモデルで OpenAPI/Swagger を有効化した HTTP トリガー Functions を作りたい 環境 Visual Studio Community 2022 17.9.6 .NET 8(C#12) 背景 .NET 6 の Azure Functions インプロセスモデルでは Function を作成する際に Http trigger with OpenAPI という選択肢があり、簡単に OpenAPI/Swagger を導入できた 分離ワーカーモデルでは Http trigger with OpenAPI の選択肢がなくなってしまった 分離ワーカーモデルでも Swagger を使いたい！ インプロセスモデルを確認する Azure Functions プロジェクトの作成時に Function で Http trigg
久しぶりの、SwaggerでLambdaのデバッグ環境を作る の拡張です。 第一回の投稿はこちらから：SwaggerでLambdaのデバッグ環境を作る(1) AWS S3にファイルがアップロードされたときにLambdaを起動するスクリプトを書こうと思っても、Lambda上でのデバッグは大変なので、ローカルでデバッグ(実行中のブレイクを入れたり、変数を参照したり)できるようにします。 S3は、本物ではなく、S3互換のMinIOを使います。 今回のローカルデバッグ環境は以下のGitHubに反映済みです。 poruruba/swagger_template https://github.com/poruruba/swagger_template MinIOのセットアップ ほぼこちらに書いてある通りに進めます。 MinIO Quickstart Guide https://docs.min.io/
はじめに 前回記事に引き続き、今回もprotoファイルを分けた時の困りごとについてです。 例えば増えすぎたserviceを複数ファイルに分けて記述するようにしたときに、そのままそこからswaggerファイルを出力しようとするとprotoファイルの数だけswaggerファイルが出来上がってしまいます。 それは絶対にやだやだということで複数protoファイルからswaggerファイル1つにまとめて出力する方法を調べたところ日本語情報がなかったようだったので残しておきます。 実践 このようなディレクトリ構造だった場合について考えます。 . └── pb ├── swagger └── type ├── item.proto ├── shop.proto └── user.proto
Swagger備忘録 - Qiita
開発手法 主要な開発手順としては、以下二つのものがあるようです。 トップダウン形式： SwaggerEditorでSwagger Specificationを編集、定義 SwaggerCodegenでSwagger Specificationからソースコードを生成 ボトムアップ形式 既に存在するREST APIのソースコードからSwagger Coreのアノテーションなどを使用しSwagger Specification定義 生成されたSwagger SpecificationをもとにSwagger UIによって、RESTAPIをドキュメント化 競合ツール OpenAPIの仕様に基づくツールとしては、他はRamlとAPI BluePrintが有名どころである。 Raml RESTful API Modeling Languageの略でその名の通りREST APIを設計するための言語。 その
はじめに Another works サーバサイドエンジニアの釜地です！ みなさんOpenAPI(Swagger)は使用されていますか？ 本記事ではOpenAPIを導入するに当たって、合わせて利用して便利だったツールを紹介したいと思います。 そもそもOpenAPI(Swagger)とは？ OpenAPI仕様（以下OAS）と言われるREST APIを定義するための標準仕様にもとづいて構築された一連のオープンソースツールです。 REST APIの設計、構築、文書化、および使用に役立つ機能を提供します。 弊社の課題感 現状、フロントとサーバを分業制で開発している上で下記のような課題がありました。 APIの伝達がJiraのドキュメントであり、フォーマットが統一されず作成するたびに若干書き方が変わる API仕様が蓄積されていかない → 開発チームが大きくなったときのために今の内からドキュメントを残し
【NestJS】NestJSでOpenAPI（Swagger）形式で出力 - 開発覚書はてな版
概要 NestJSではOpenAPI（Swagger）形式でAPIドキュメントを出力できます。 以下のドキュメントを参考に設定をしていけばドキュメント出力が可能です。 docs.nestjs.com OpenAPIに出力したい内容がデコレータで定義できるので、APIドキュメントと実際のAPIの差が無くなりやすくなります。 設定方法 @nestjs/swagger と swagger-ui-express をパッケージに追加。 SwaggerModule と DocumentBuilder を使用してAPIドキュメントの出力設定をする。 ApiModelProperty デコレータなどを使用してAPIに出力する内容を記載していく。 サンプル 実行環境 Node.js - 10.x Yarn - 1.13.x 使用ライブラリ @nestjs/common - 6.0.x @nestjs/cor
Swaggerで定義したAPI仕様を使ってスタブ（モック）サーバーを構築します。こちらのソースコードを使って説明していきます。 https://github.com/takiguchi-yu/SwaggerMocking アーキテクチャ 流れは以下の通りになります。 開発者は VSCode を使って swagger.yaml を記述する swagger-codegen を使って yaml を json に変換する 変換した json を使ってスタブサーバーのコードを生成する docker-compose up をしてスタブサーバーを実行する ディレクトリ構成 . ├── Dockerfile # Node.jsのDockerイメージ ├── docker-compose.yml # Swagger UIとNode.jsのコンテナ起動 ├── gen # Swagger Generatorの
前回Swaggerについて調べて実際に使ってみました。 前回はwebからyamlファイルを生成し作成する方法でしたが、今回はDockerを使った方法を試してみます。 前回と同じくまだDockerについて浅い知識しかないのでご指摘などありましたらご連絡いただけますと幸いです。 前回の記事は以下です。 Swaggerについて調べてみた 今回参考にさせていただいた記事は以下です。ありがとうございます！ UI開発にSwaggerで作ったmockサーバーを使う Swaggerの概要をまとめてみた。 DockerでSwagger Editorを立ち上げる DockerHubにあるイメージをpullします。 以下が公式のイメージです。 swaggerapi/swagger-editor 上記の画像にあるようにコマンドを実行していきます。 $ docker pull swaggerapi/swagger-
研修で要件定義〜基本設計をしています。 最終的にはExcelにまとめますが、Excelだと作図や見た目の調整が手間です。 そこで表題のツール3つを使ってみたところ、効率よく作成できたので紹介します。 MermaidでER図を作成 MermaidではER図を作成しました。 テキストを書くと、勝手に見た目を整えて作図してくれます。矢印や枠をイジイジする時間から解放されます…！ 公式ドキュメントを見ながら描きましたが、簡単すぎて感動です！ 慣れない方は、こちらの記事から触り始めると分かりやすそうです。 似たツールにPlantUMLがありますが、MermaidはNotionに埋め込めるメリットがあるのでこちらを採用しました。 社内文書にNotionを採用してるので、覚えておくと後々便利に使えそうです。 Figmaで業務フロー・画面遷移図・画面レイアウトを作成 Figmaでは業務フロー、画面遷移図、
概要 WebAPIの仕様書を書く際、何を使って書くかを考え、どうせなら OpenAPI の仕様に沿ってちゃんと書いてみようと思った。 その際のツールとして、SwggerEditor はすぐに利用できるので、便利でとっつきやすいと思う。 ただ、ローカル環境で SwggerEditor を使おうと思うと、Dockerなどを使って環境を整備しなくてはいけないので面倒。 自分が普段使っているエディターでもある VSCode（Visual Studio Code）で使えるプラグインがあったので、その紹介。 自分が編集しているyamlファイルの内容をSwaggerUIの画面に変換した状態で表示できる。 編集内容もリアルタイムで反映されるため、記述内容での見え方（改行など）の調整にも便利。 インストール方法 VSCodeの「Extensions」を開く。 検索欄に「SwaggerViewer」と入力する
チーム開発をする時にAPI仕様書をOpenAPI形式で書くことが多いかと思います。 その場合によく問題になるのはその仕様書をSwaggerでホスティングする場所です。 チームの人数が少なければ、各自の環境でdockerなどを使ってSwaggerを立ち上げても良いですが、人数が多くなるとどこかでホスティングしたくなります。 この記事ではGitHub Pagesでホスティングするための設定を紹介します。 設定例 以下のYAMLファイルをGitHub Actionsで実行することで簡単にSwaggerをGitHub Pagesでホスティングできます。 GitHub Pagesの公開設定をPrivateにすることで、特定の組織に属している人のみに公開するという認証もできます。 name: "swagger release" on: pull_request: branches: - 'main'
OpenAPIを採用するプロジェクトが増え、Swagger UIで生成されたAPIドキュメントを見る機会も多くなりました。 目にする機会が増えると、ドキュメント上の見づらい部分（個人の感想です）が少し目に付きます。 そこで、Swagger UIのドキュメントをStyleをイジって「すこしだけ」見やすくできないか試みてみました。 Style変更箇所 見づらいと感じたのは以下の点です。 RequestやResponseのExample Responseのテーブル これらの箇所のStyleを変更してみました。 RequestやResponseのExample Before フォントサイズが小さく、weightが太めに設定されているため、文字が潰れて見づらい。 After フォントサイズを大きめに変更 12px -> 15px weightをnormalに変更 フォントを等幅のものに変更 Resp
はじめましての方ははじめまして。Scala エンジニアの Javakky です。 なぜ Swagger を導入するのか？ 弊チームの提供している API のドキュメントはこれまで Notion で管理していました。Notionはチームのナレッジ共有として大変便利なのですが、この用途ではデプロイ後に手動で書き換えが必要だったり、変更履歴が見づらかったりといった問題点がありました。 また、各環境でエラー対応を行う場合には、 curl を利用した呼び出しをおこなっていました。 社内の他チームで採用実績のあった Swagger UI が上記を快適にしてくれそう。というモチベーションから、導入検討が始まりました。 Swagger API spec generator for Play 弊チームでは Scala + sbt + Play Framework を利用した開発がベースのため、 routes
openapi3系で書きます バージョン違うとエラーが出ます。 最新で頑張るのだ！(｡- .•) Swagger EditorでDeleteを定義したけれど、delete_flg, invalid_flgといった論理削除や論理無効化で処理することが多いっぽい。だから実践ではDeleteメソッドは利用せず、PUTメソッドを利用したUPDATE処理で論理削除を行うことが多いのだろうな。 @see OpenAPI Specification 3.0 チートシート(外部サイト) ReDoc(外部サイト) SwaggerのyamlをHTMLドキュメントに変換してくれるサービス CRUDが一通りできた openapi: 3.0.0 info: title: ポケモンで学ぶSwagger(OpenAPI) + Laravel API version: 1.0.1 servers: - url: http
背景 swaggerに次のようなエラーレスポンスを追加したときに、クライアント側でどのようにハンドルして取り出すのか少し迷った。 ... responses: "500": schema: "#/definitions/Error" headers: X-Hogefuga: type: string ... クライアントでのハンドリング swagger generate clientで生成されるコードにエラーレスポンスの型情報があるので、型アサーションしてあげると取れる。例えば500だと[...]InternalServerErrorがそれにあたる。 rep, err := api.Application.Get(params) if reterr, ok := err.(*application.GetInternalServerError); ok { return fmt.Erorf
package com.example.spring.boot.web import com.example.spring.boot.web.sample.HogeController import com.example.spring.boot.web.sample.SampleController import com.fasterxml.classmate.TypeResolver import com.google.common.collect.Lists.newArrayList import org.springframework.beans.factory.annotation.Autowired import org.springframework.boot.SpringApplication import org.springframework.boot.autoconf
Swaggerから静的（Webサーバ不要でローカルに保存したファイルをブラウザで開いて表示できる）HTMLを生成する方法を調べました。 (1) redoc-cli redoc-cli を使うとコマンドラインでSwaggerファイルを静的HTMLに変換できる。 インストール
GoのSwaggerでFailed to load API definitionエラーが発生する - Qiita
はじめに 仕事でGo開発を始めてREST APIのためにgin-swaggerを導入したのですが、記事通りにやってエラーが発生しました そこで2度同じ現象につまづいたのでまとめていきます 問題 gin-swaggerを設定してブラウザを開いたところ以下の画面になりました
go-swaggerで`ParseComment error in file /go/src/controller/xxx.go :cannot find type definition: json.RawMessage` - Qiita
経緯 GORMのmodelにてjson.RawMessageを定義してると、go-swaggerのswag initでドキュメント生成に失敗する /go/src # swag init 2022/04/28 07:10:29 Generate swagger docs.... 2022/04/28 07:10:29 Generate general API Info, search dir:./ 2022/04/28 07:10:29 Generating xxxxxxxxx 2022/04/28 07:10:29 Generating xxxxxxxxx 2022/04/28 07:10:29 Generating xxxxxxxxx 2022/04/28 07:10:29 Generating xxxxxxxxx 2022/04/28 07:10:29 ParseComment err
はじめに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に依存したくないというポリシーを強く持つこと、開発前にある程度固く機能数を洗い出して工数見積もりや開発スケジュールに活かしたいといった大人な事情など、色々相性が良
1.はじめに DockerでSwagger UI使用する際、DockerのコンテナにVolumeなどの設定を適切に行わないと、任意のAPI仕様書を参照させることが出来なかったため、Swagger UIにてAPI仕様書を参照できるまでの手順を記載する。 2.前提条件 Dockerが使用できる状態であること。 3.Swagger UIのコンテナを取得する 3-1.DockerHubからコンテナを取り込む 下記のコマンドを実行して、swagger-UIのコンテナをDockerに取り込む。
https://start.spring.io/ からwebのみを選択してパパッと作成 Swaggerはなかったので、Maven Repositoryから持ってきた versionなどは build.gradle 参照してもらいたい サンプルコード https://github.com/ririkku/swagger-demo 試せる最小構成 コード全量 plugins { id 'org.springframework.boot' version '2.2.1.RELEASE' id 'io.spring.dependency-management' version '1.0.8.RELEASE' id 'java' } group = 'com.example' version = '0.0.1-SNAPSHOT' sourceCompatibility = '1.8' reposit
スキーマ駆動開発とは 簡単に言うと、先にAPIのスキーマ (request, responseの型やフィールド名の定義)を決め、それに伴ったドキュメントとモックの生成をシステマティックに行った上で内部の実装を行う開発手法です。(参考: チームのWeb API開発を最適化するSchema Driven Developmentの解説＆実装例) pythonのwebフレームワークであるresponderでスキーマ駆動開発をやってみたいと思います。 以下の様なSwaggerが見れるようになるのがゴールです。 responder PythonのモダンなWeb フレームワークです。 ボリューム感的にはflaskやbottleのようなマイクロフレームワークです。 以下の様に書いて、$ python xxx.py のように実行するだけで、JSONを返すAPI serverが起動します。 import re
{"swagger":"2.0","info":{"description":"Api Documentation","version":"1.0","title":"Api Documentation","termsOfService":"urn:tos","contact":{},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0"}},"host":"localhost:8080","basePath":"/","tags":[{"name":"basic-error-controller","description":"Basic Error Controller"},{"name":"family-controller","description":"Family Con
QuarkusでRESTEasy Reactive × OpenAPI、Swagger UI - CLOVER🍀
これは、なにをしたくて書いたもの？ QuarkusのExtensionに、OpenAPIおよびSwagger UI向けのものがあるようなので試しておきたいなと思いまして。 Quarkus - Using OpenAPI and Swagger UI もうちょっと言うと、ドキュメントに書かれているのは通常のRESTEasyのものなので、RESTEasy Reactiveと組み合わせても動くのかな？ というのが知りたかったことです。 結論を言うとあっさりと動いてしまったので、ついでにOpenAPI、Swagger事情に疎いこともあって、このあたりも調べてみました。 OpenAPIとSwagger そもそも、OpenAPIとは？ということで。 こちらは、OpenAPI仕様の標準化を行っているOpenAPI Initiative（OAI）のサイトです。OpenAPI仕様は、こちらからたどることがで
OpenApi bake theme pluginをswagger-phpのアトリビュート形式で吐き出すように修正しました - kaz29
最近は、アプリの開発・実行基盤の構築でインフラエンジニアっぽいことばかりやっていて、プロダクションのコードを書いていなくてストレスが溜まりつつある渡辺です 今構築している環境では、PHPでAPIを書いていて、swagger-phpでAPIドキュメントを作成して、フロントアプリとの連携をしています。以前書いたブログで OpenApi bake theme plugin や swagger-phpを紹介しているので参考にしてみてください。 kaz29.hatenablog.com kaz29.hatenablog.com 当初、OpenApi bake theme pluginを使ってアノテーション形式で記載しようと思っていたのですが、構築するにあたりswagger-phpの開発状況を確認したところ、かなりアップデートされていて、より便利に使えそうなのでほとんどメンテナンスしていなかった、 O
Nest.js+MySQLで動くCRUD+認証APIサーバをDocker+VSCode+Swaggerで構築してみる - Qiita
はじめに HAL Advent Calendar初参加のHAL大阪Web4年の小澤です。 今年一番世話になった言語,フレームワーク,ライブラリについて感謝の念を込めて(文量的に)カロリー高めのハンズオン記事を書いてみました。 対戦よろしくお願いします。 ■ タイトルやたら長いけど何が目的？ 学校の授業では学べない(であろう)TypeScriptを広めたい TypeScriptについて学ぶ為の(体感で)前工程に掛かる時間が一番少なかったNest.jsを広めたい Swaggerの便利さとそれを自動生成できる機能の快適さを広めたい Nest.jsの認証機構の実装についての資料を残したい VSCode + TypeScript(ECMAScript) + Docker構成のDXの良さを広めたい (DX: Developer Experience) ※ 当記事はMacユーザーを対象としています。 (
はじめに API設計を行う際の環境構築についての調べた内容です。 目的 環境構築の目的は以下の2つです。 Swaggerを用いたAPI仕様書の作成(設計)を行う。 作成したAPI仕様書の沿ったレスポンスを返すモックサーバーを作成する。 上の目的を踏まえてSwagger-ui-watcherとAPISproutを用いて環境を作成します。 また、API仕様の作成方法としては専用のツール(Swagger-editor)を用いる方法もありますが、今回はローカルでファイル作成を行う方法を採用します。 Swagger-ui-watcher Swagger-uiはSwaggerで定義したAPI仕様をブラウザ上で可視化するツールです。 Swagger-ui-watcherはローカルで作成した仕様ファイルの表示に特化したもので、仕様ファイルの変更時にブラウザに表示されたSwagger-uiの画面を自動で更新
ドキュメントルートに配置・確認 ビルド後swagger-ui/distディレクトリをドキュメントルートに配置します。 デフォルトで読み込むSwaggerファイルを変える デフォルトで読み込むSwaggerファイルをhttps://petstore.swagger.io/v2/swagger.jsonから任意のURLに変えたい場合は、index.htmlの42行目のURLを任意の値に編集します。 window.onload = function() { // Begin Swagger UI call region const ui = SwaggerUIBundle({ url: "https://petstore.swagger.io/v2/swagger.json", // 任意のURLを設定 validatorUrl: null, // URLバリデーターを無効化 dom_id: '
module Versions module V1 class API < Grape::API version 'v1', using: :path format :json formatter :json, Grape::Formatter::Jbuilder prefix :api # エラー対応 rescue_from :all, backtrace: true error_formatter :json, ::MediaSite::ErrorFormatter include ::Versions::V1::TaskDisplays # :nocov: if Rails.env.development? || Rails.env.staging? add_swagger_documentation add_version: true end # :nocov: end end e
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Wordな職場にSwaggerを定着させようとして失敗したけど結局定着した話 - Qiita
GO/Gin gin-swagger使用してAPI仕様書を生成します - Qiita
Swaggerの利用基盤をdockerで構築しGitHub Pagesで公開する
Go の HTTP サーバーで Swagger UI を提供する
Swagger-UIでプルダウンでYAMLファイルを切り替える (API_URLS) - Qiita
Swaggerを分割して管理しやすくする | 株式会社PLAN-B
【Unity】OpenAPI(Swagger)からopenapi-generator-cliを使用してコードを自動生成する
SwaggerでLambdaのデバッグ環境を作る(7)：AWS S3トリガをデバッグする - Qiita
複数のprotoファイルから出力するswaggerファイルを1つにまとめるお話 - Qiita
Stoplightの使用感がかなり良かった話(OpenAPI,Swagger) - Qiita
【Swagger】Docker環境で簡易モッキング - Qiita
Swaggerについて調べてみた(Dockerバージョン) - Qiita
Mermaid、Figma、Swaggerで基本設計やってみた【今週の振り返り】
Swagger Viewer（VSCodeプラグイン） - Qiita
GitHub PagesでSwaggerをホスティングするGitHub Actionsの書き方 - Qiita
Swagger UIをすこしだけ見やすくしてみた - 無理しない感じ
Play プロジェクトに Swagger UI を導入した話 - pixiv inside
ポケモンで学ぶSwagger(OpenAPI) | 優技録
go-swaggerでエラーレスポンスをハンドルする - Qiita
Spring Fox＋SwaggerでAPI仕様書作成 - Qiita
Swaggerから静的HTMLを生成する - Qiita
go-swaggerを用いたWebアプリケーション開発Tips19選 | フューチャー技術ブログ
DockerでSwagger UIを起動してAPI仕様書をブラウザに表示する手順 - Qiita
Spring Boot + Swagger2.0の触り心地を確かめてみる - Qiita
Responderでスキーマ駆動開発: Swagger UIの表示までやってみる - Qiita
SpringFoxを使ってSwaggerのjsonを吐き出す - Qiita
REST API設計のためのローカル環境構築(Swagger, APISprout) - Qiita
Swagger UIとSwagger EditorをWebサーバで動かす - Qiita
Rails 6 Grapeを利用したAPI作成、Swaggerでの確認 続編 - Qiita