SWAGGER

こんにちは、決済サービスの開発を担当している近藤です。決済サービスでは多くのプログラムで.NET Framework 4.8を使用して開発をしていますが、.NET 6 での開発も増えているところです。今回は .NET 6でAPIドキュメントを作成する際に使用するSwaggerについて簡単な導入方法をご紹介します。 SwaggerはAPIドキュメントを作成するためのツールセットです。.NET 6 ではNugetパッケージ「Swashbackle.AspNetCore」を取得することで使用できます。これを使うことでREST APIのコードとコメントからAPIドキュメントを作成できるため、ドキュメン…

API Blueprintファイルへの変換 Swaggerファイルへの変換ツールとして API Elements CLIを使用する。 API Elements CLI(Github) サンプルとして、以下のSwaggerファイルをAPI Blueprintファイルに変換する。 openapi: '3.0.0' info: title: サンプルAPI description: API仕様サンプル用 termsOfService: http://example.com/terms/ contact: name: APIサポートセンター url: http://www.example.com/su…

Swaggerファイルを使用してモックサーバを起動する方法をまとめる。 モックサーバーには prism を使用する。 prism(Github) 仕様書作成準備 作成したAPI仕様書を管理するためのディレクトリを作成し、npm initコマンドを実行する。 以下は作成されたpackage.jsonの例である。 { "name": "api", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }…

APIがいっぱいあって、1つのSwaggerファイルに全部を書きたくないときのためのメモ。 複数ファイルへの分割 サンプルとして、以下のファイルを複数ファイルに分割する。 openapi: '3.0.0' info: title: サンプルAPI description: API仕様サンプル用 termsOfService: http://example.com/terms/ contact: name: APIサポートセンター url: http://www.example.com/support email: support@example.com license: name: Apach…

API の開発について知見を増やそうと思い swagger について調べてみました。 Swagger とは 特徴 ツール Swagger Editor Swagger UI Swagger Codegen チュートリアル Swagger とは Swagger は RESTful APIを構築するためのオープンソースのフレームワークのことです。 RESTfulAPI を楽に設計、製造しようというプロジェクトのようで海外では結構使われているみたいです。swagger.io 特徴 Swagger Specという仕様を元にドキュメントを記載しておけば、自動で見やすいドキュメントやコードの生成などが行え…

Summary expressに記述している複数のルーティングを一括でテキストまたはjsonに出力できないか調べてみました。 References github.com Example Code 下記のコードで記述するとPath及びPathに紐づくメソッド名が取得できる。 router.stack.filter(r => r.route).map(r=> { return {"path":r.route.path, "methods":r.route.methods} }) ExpressのＡＰＩ経由でPathとメソッドの情報を取得した場合 router.get('/test', functi…

バージョン 現在 swagger 2.0 openapi 3.0(swagger 3.0) があるが、「openapi 3.0」がよい。「openapi 3.0」から「oneOf」属性がサポートになっており、「いづれかひとつ」を表現できるようになっている。 参照：oneOf, anyOf, allOf, not example、examplesでcomponents（定義）を参照する方法 components: examples: XXXX: に定義する必要あり。（components/schemas等ではなく、components/examplesに定義する） content: applic…

Designing APIs with Swagger and OpenAPI 目次 目次 はじめに Open APIの特徴 1. YAMLやJSONなどのテキストファイルで仕様を記述できる。 2. OpenAPIの仕様データから、仕様書を自動生成できる。 3. OpenAPIの仕様データから、APIのクライアントやサーバのコードを自動生成できる Open APIの仕様の書き方 シングルHTMLファイルのAPIドキュメントを生成する 参考資料 MyEnigma Supporters はじめに REST APIは、ソフトウェアのAPIの基本だと思いますが、 そのドキュメントの書き方は結構悩ましい…

こんにちは！エンジニアのはっしーです！ 今回はFluentValidationを使用して、ネストされた値を検証する方法を紹介したいと思います。 FluentValidationとは FluentValidationは値の検証を行うための.NETライブラリです。 FluentValidation — FluentValidation documentation プロジェクトの作成 Visual Studioを開きます。 新しいプロジェクトの作成を選択します。 テンプレートからASP.NET Core Web APIを選択します。 任意のプロジェクト名とソリューション名を入力します。 （今回のサン…

5月の読書メーター読んだ本の数：1読んだページ数：432ナイス数：19C#フレームワーク ASP.NET Core入門 .NET 7対応の感想ざっと読んだ。.NET Coreでマルチプラットフォーム対応して、webアプリはMVCからRazer、Brazerと進化する過程で、Program.csは軽量化し、cs.htmlや.razedといったVue.jsを思わせる言語が新登場。一方で、WebAPIは.NET Core APIがSwagger対応。読了日：05月20日 著者：掌田津耶乃読書メーター posted by AWS Lambda

（本記事は2023/5/26時点の情報にアップデートしております） こんにちは、技術広報のyayawowoです。 突然ですが、株式会社ラクスと聞いて何を思い浮かべますでしょうか？ 弊社ラクスでは、様々なプロダクトを展開していますが正直認知度は低いと思っております。 そこで今回、弊社についてもっともっと知っていただくため・・・ ラクスが展開している全10プロダクト 全10プロダクトの技術スタック インフラ/SRE/デザイナーの技術スタック について、ご紹介させていただきます！ SaaS開発に携わる方、弊社に少しでも興味を持っている方の一助となれば幸いです！

皆さんこんにちはこんばんは！Rinです☺️💡✨ 今回紹介する曲は、オーストラリアのラッパー、イギー・アゼリアの「Fancy」です。 この曲はイギリスのシンガーCharli XCXをフィーチャーした楽曲で、デビュースタジオアルバム『The New Classic』（2014）に収録されています。

はじめに 今回はOpenAPIについて取り上げたいと思います。 The OpenAPI Specification (OAS) defines a standard, programming language-agnostic interface description for HTTP APIs. This allows both humans and computers to discover and understand the capabilities of a service without requiring access to source code, additional do…

こんにちは。カート決済部カート決済基盤ブロックの高橋です。 カート決済部では、現在Spring BootのJavaプロジェクトを運用しています。今回Spring Bootのバージョンアップを実施した際に発生した問題点と対応内容、注意点をご紹介します。加えて、使用しているライブラリなどのバージョンも上げているのでご紹介します。 アップデート前後のバージョン 種類 前バージョン 後バージョン Java 17 17 Spring Boot 2.7 3.0 Gradle 7.x 8.x SpringFox 3.0.0 - Springdoc-openapi - 2.1 openapi-generato…

エンジニア・プログラマーの学習に約立つコンテンツのセール情報を集めました 1位 現役シリコンバレーエンジニアが教えるPython 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイル ¥27,800 → ¥1,600 94%OFF!! ⭐ ⭐ ⭐ ⭐ （20,561件） 現役シリコンバレーエンジニアが教えるPython入門！応用では、データ解析、データーベース、ネットワーク、暗号化、並列化、テスト、インフラ自動化、キューイングシステム、非同期処理など盛り沢山の内容です！ 2位 【キカガク流】人工知能・機械学習 脱ブラックボックス講座 - 初級編 - ¥15,800 → ¥1,500 …

チーム開発でSwaggerを導入してみたのですが、ソースコードまたはドキュメントの自動生成を使わなかったところ、後から痛い目を見たという話です。 OpenAPIとは？ OpenAPI Specificationの略。 REST APIの定義を記述するための規格で、yamlやjsonで記述することができます。 https://www.openapis.org/ Swaggerとは？ REST APIを構築するためのツール群。 これにより、フロントエンドとサーバサイドの同時開発が可能になります。 今回の要件 フロントエンドとバックエンドで直接話さなくてもAPIの仕様を確認できるようにしたい API…

エンジニア・プログラマーの学習に約立つコンテンツのセール情報を集めました 1位 現役シリコンバレーエンジニアが教えるPython 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイル ¥27,800 → ¥1,600 94%OFF!! ⭐ ⭐ ⭐ ⭐ （20,561件） 現役シリコンバレーエンジニアが教えるPython入門！応用では、データ解析、データーベース、ネットワーク、暗号化、並列化、テスト、インフラ自動化、キューイングシステム、非同期処理など盛り沢山の内容です！ 2位 【キカガク流】人工知能・機械学習 脱ブラックボックス講座 - 初級編 - ¥15,800 → ¥1,500 …

エンジニア・プログラマーの学習に約立つコンテンツのセール情報を集めました 1位 現役シリコンバレーエンジニアが教えるPython 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイル ¥27,800 → ¥1,600 94%OFF!! ⭐ ⭐ ⭐ ⭐ （20,550件） 現役シリコンバレーエンジニアが教えるPython入門！応用では、データ解析、データーベース、ネットワーク、暗号化、並列化、テスト、インフラ自動化、キューイングシステム、非同期処理など盛り沢山の内容です！ 2位 【キカガク流】人工知能・機械学習 脱ブラックボックス講座 - 初級編 - ¥15,800 → ¥1,500 …

エンジニア・プログラマーの学習に約立つコンテンツのセール情報を集めました 1位 現役シリコンバレーエンジニアが教えるPython 3 入門 + 応用 +アメリカのシリコンバレー流コードスタイル ¥27,800 → ¥1,600 94%OFF!! ⭐ ⭐ ⭐ ⭐ （20,544件） 現役シリコンバレーエンジニアが教えるPython入門！応用では、データ解析、データーベース、ネットワーク、暗号化、並列化、テスト、インフラ自動化、キューイングシステム、非同期処理など盛り沢山の内容です！ 2位 【キカガク流】人工知能・機械学習 脱ブラックボックス講座 - 初級編 - ¥15,800 → ¥1,500 …