Swaggerで作るSPECファイルを小さいファイルに分割する｜ハンズラボ株式会社
こんにちは、井上です。 「Swaggerで始めるモデルファーストなAPI開発」を見て興味を持ったので、Swaggerをちょっと触ってみたのですが、すぐに、これ1ファイルの YAMLファイルでメンテナンスするの超しんどくない？と感じました。 なので、分割する方法を調べてみました。で、みつけたのが下記エントリ。 How to split a Swagger spec into smaller files 方法としては、別々のファイルに書いた定義を $ref で参照しておき、それを json-refs でマージして1ファイルに戻すというやり方のようです。 下記のような YAML ファイルを、 swagger: '2.0' info: version: 0.0.0 title: Simple API paths: /foo: get: responses: '200': description:
Swagger definition からクライアントとサーバーのソースコードを生成してみた - present
前回は簡単な Web API の Swagger definition を書いただけで終わってしまったけど、 ここからが本題。 やりたいのは、Swagger definition からクライアントとサーバーのソースコード生成すること。 そのためのツールとして swagger-codegen が提供されている。 http://swagger.io/swagger-codegen/swagger.io お試しなので、Homebrew や mvn を使わずに直接 jar をダウンロードしてしまおう。 http://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.1.5/swagger-codegen-cli-2.1.5.jar 前回の Swagger definition を sample_api.yml として保存し、 まずは A
swaggere3.0で独自の認証用ヘッダを定義する - コード日進月歩
例えばカスタムヘッダでそこに認証用のキーを埋め込んでほしい場合などの書き方。OAuthとかBasic認証はあるのだけど、そういうポピュラーなものではなくオリジナルをやりたい場合の例。 書き方 securitySchemes にtypeを apikey にした情報を定義する 利用したいエンドポイントで secure の項目を追加して指定する 実例 /user のエンドポイント に 認証用のコードとしてSECRETHEADERCODEを入れるようにヘッダに指定したい場合 securitySchemesの定義 以下の用に定義する components: securitySchemes: API_SECRETCODE: type: apiKey description: ヘッダに乗せるシークレットキー in: header name: SECRETHEADERCODE エンドポイントに追加 以下の
何？Swaggerって？ - ponsuke_tarou’s blog
お仕事で「APIの仕様書をすわっがーで作ってね」って言われました、既存の仕様書はYAMLファイルになっているのですが・・・何？Swaggerって？ Swaggerは、OpenAPI仕様に基づいてREST APIの仕様書作成から構築を助けてくれるツールです。 OpenAPIは、REST APIの記述フォーマットです。 Swagger3.0は、OpenAPI？ ブラウザで仕様書を見て書けます。 実行もできます。 GitにあるSwaggerのファイルをプレビューできるChrome拡張機能があるらしいです。 Serversを書く 認証を書く Bearer スキームを書く 共通で使うオブジェクトや構造の定義を書く リクエストを書く パラメータを定義する レスポンスを書く レスポンスのexampleを複数定義する YAMLファイルに保存する Swaggerは、OpenAPI仕様に基づいてREST AP
ASP.NET Core Web APIのチュートリアルを丁寧にやってみた
本記事の対象 ASP.NET Core Web APIの基本的な仕組みを理解したい C#、REST APIの基本的な知識がある 環境 Windows 11 Visual Studio 2022 .NET 8 プロジェクトの作成と実行 Visual Studioを起動したら、新規プロジェクトの作成画面を開き、「ASP.NET Core Web API」を選択します。 プロジェクト名はチュートリアルと同じ「TodoApi」にしました。 ターゲットフレームワークには「.NET 8.0(長期的なサポート)」を選択します。その他の項目はデフォルトのままでOKです。 プロジェクトの作成が完了したら、「Ctrl＋F5」でデバッグなしで実行してみましょう。 もし、次の画面が表示された場合は「はい」を選択して証明書をインストールしてください。 ブラウザが起動し、以下のようなSwagger UIのページが表示
ASP.NET Core 5.0 APIのSwaggerを設定する - Qiita
はじめに .Net Framework 4.8がリリースされて、.Net Frameworkが遂に、アップデート停止になりました。 (バグ修正やセキュリティ修正は、継続されます。2020/12/17現在) 早急に対策が必要なわけではありませんが、.Net Coreへのマイグレーションを少しづつ進める必要性が高くなったというサインだと思います。 旧システムの.NET 5へのマイグレーションを進めるなかで、調査したSwagger設定を備忘録として、書き記します。 Swaggerとは Swaggerは、Wordnik Society社が、自社のAPIドキュメントの自動化のために作成したツールが源流になっているようです。 Apache 2.0オープンライセンスによって公開されていて、Apigee、Intuit、Microsoft、IBMなどに採用されたことで、広く知られるようになっていきます。 現
Swaggerをちょっとだけ使いやすくするyamlの書き方 - Qiita
基本的な書き方は「swaggerの基礎。swaggerの設定ファイルの書き方とか」を参照 この記事は上記の内容を前提に、補足程度の情報を記載。 追加があったら都度、追記するかもしれない。 サンプルを記載する そのまんま。swagger-editorのプレビューやswagger-UIのAPI一覧でサンプルを見ることができる。 ぱぱっと内容を把握するのに便利。 「examples:」から諸々を記載。以下の例はSwagger-editorのサンプルにある、instagramのyamlから抜粋して加工してある。 paths: /users/{user-id}: parameters: - $ref: '#/parameters/user-id' get: security: - key: [] - oauth: - basic tags: - Users description: Get basi
実用SwaggerCodegen - Qiita
SwaggerCodegenとは This is the Swagger Codegen project, which allows generation of API client libraries (SDK generation), server stubs and documentation automatically given an OpenAPI Spec. Currently, the following languages/frameworks are supported: SwaggerCodegenはOpenAPIの仕様に沿ったファイルを変換し，APIのクライアントやスタブサーバー，ドキュメントを自動生成するプロダクトです． 今回は，このSwaggerCodegenの使い方や拡張の仕方，実用への課題などを書きたいと思います． SwaggerCodegenの難しさ 圧倒
VScodeでOpenAPIを書くために便利なプラグイン一覧
はじめに 開いていただきありがとうございます。 OpenAPIを書く際はこれまでブラウザ上の「Swagger Editor」を使用していました。 プラグインを入れることでVScodeでも書けることがわかった(おそらく今後は全部VScodeで書くことになるんだろうな・・・)ので、その際に使用したプラグインをまとめてみようと思います。 プラグイン Swagger Viewer viewerを開くには以下の方法で行います。 コマンドパレットから「Preview Swagger」を選択 shift + option + p 以下のようにSwagger Editorと同じ画面で確認することができます。 また、編集はリアルタイムで更新されます。 openapi-lint openAPIのドキュメントを検証や静的解析を行ってくれる拡張機能です。 OpenAPI(Swagger) Editor エクスプロ
Swaggerで始めるモデルファーストなAPI開発
This document summarizes a microservices meetup hosted by @mosa_siru. Key points include: 1. @mosa_siru is an engineer at DeNA and CTO of Gunosy. 2. The meetup covered Gunosy's architecture with over 45 GitHub repositories, 30 stacks, 10 Go APIs, and 10 Python batch processes using AWS services like Kinesis, Lambda, SQS and API Gateway. 3. Challenges discussed were managing 30 microservices, ensur
RESTful APIの記述標準化を担うSwaggerとは？ | NTT Communications Developer Portal
先日、Open API Initiativeの設立が発表されました（via RESTful APIの記述標準化を目指す「Open API Initiative」をマイクロソフト、Google、IBMらが立ち上げ。Swaggerをベースに － Publickey）。これにより、RESTful APIが各企業間において標準化され、より広まっていくものと考えられます。 そんなRESTful APIを広めていく中で必要な要素になるのがドキュメントです。APIは開発者向けの画面はなく、プログラムからコールして利用します。そのため、分かりやすいドキュメントが必須になります。その標準フォーマットとして取り上げられているのが今回紹介するSwaggerです。 Swaggerはドキュメントフォーマットおよびビューワーになります。Swagger自体オープンソースとして公開されており、関連するツールやライブラリも
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Swagger Codegen の使い方