OpenAPI v4.0 (A.K.A "Project Moonwalk") · Bump.sh
What is coming next for OpenAPI, as v4.0 of the OpenAPI Specification gets closer to being released? What major changes are coming, how easy will it be to upgrade, and how do tooling companies feel about it? Recent History of OpenAPI OpenAPI has been around for a long time, but only hit the mainstream when OpenAPI v3.0 was released in 2017. It made it a whole lot easier to describe the majority of
How to use JSON Path · Bump.sh
A few years ago most API designers, developers, and technical writers would have had very little reason to bump into JSONPath, but its starting to get more and more relevant as more tools and standards start relying on it. So what is JSONPath, what is it used for, and how can you get up to speed with using it? JSONPath is a query language that can be used to extract data from JSON documents, which
OpenAPIのschemasで JSONデータを検証する方法 - OPTiM TECH BLOG
はじめに ビジネス統括本部のイチノです。最近は、ChatGPTにシェルスクリプトの書き方を教えてもらっています。 今回は、OpenAPIのschemasで JSONデータを検証する方法のメモです。 検証方法 openapi-schema-validator というライブラリを利用して JSON データがOpenAPIの schemas に合致するかを検証します。 pypi.org サンプルは以下のとおりです。説明用に OpenAPI のドキュメントや JSON データを直接書いています。利用する際は、データの直書きではなくファイル読み込みに修正すると使い勝手が良くなります。 #!/usr/bin/env python3 import json import yaml from openapi_schema_validator import validate from jsonschema.
OpenAPI GeneratorでPython Web API構築 | フューチャー技術ブログ
この記事はPython Advent Calendar 2022 カレンダー2の3日目です。昨日はtttakehさんのじゃんけん画像を分類してみたでした。 はじめにこんにちは。TIG DXユニットの村上です！ さて、私の所属しているプロジェクトではバックエンドシステムに主にGo言語を用いており、Go言語によるWeb APIを構築しています。 例えばLambdaとGoを使ったサーバーレスWebAPI開発実践入門など、Future Tech Blogには多くのノウハウが投稿されていますので是非ご覧になっていただければと思います。 今回はGo言語ではなくPythonでWeb APIを構築しました。その際にOpenAPI Generatorが便利だったのでご共有します。 OpenAPI GeneratorOpenAPI GeneratorはAPIリクエストやレスポンスの内容を定義し、それを元にプロ
PostmanのCollectionsで管理されていたドラフトのAPI仕様をOAS形式に変換してみた | DevelopersIO
MADグループ@大阪の岩田です。タイトル通りなのですがPostmanのCollectionsで管理作成されていたAPI仕様をOAS形式に変換してみたので手順やポイントをご紹介します。 環境 今回利用した環境です Postman: 9.30.4 postman-to-openapi: 2.3.0 移行手順 以下の手順でPostmanのCollection形式からOAS形式への変換を行い、API仕様の管理方式を移行していきました。 初期のCollectionsの状態 まず初期段階は以下のような状態でした。PostmanのCollectionsにドラフトのAPI仕様がいくつか作成されており、exampleも作られていました。これらをOAS形式に変換していきます。 Collectionsをエクスポート まずCollectionsに作成されたAPI仕様をエクスポートします。エクスポートしたいColl
CRUDでプロパティが変わるモデルをOpenAPIで書くときの定義分割 - 株式会社インサイトテクノロジー
OpenAPI記述 定義したモデルとAPI仕様をOpenAPIで記述していきます。 info, host, schema, securityなどの項目は省略しています。 コードは以下のバージョン指定で確認しています。 OpenAPI 3.0.1 Swagger Editor v3.15.10 OpenAPIバージョンはspecファイルの先頭で、Swagger EditorバージョンはDocker版のタグで指定しました。 基本的にはオンラインのSwagger Editorに貼り付けて動作するはずです。 STEP1. 取得可能属性でschemaを定義してリクエストは個別に定義する まずは最も使う頻度が多い返却データの形式でschemaを定義してレスポンスで利用します。 リクエストごとに異なる形式は個別に記述します。 openapi: 3.0.1 info: title: "STEP1" des
OpenAPIにおけるundefinedとnullの設計 | フューチャー技術ブログ
はじめにOpenAPI仕様に則ってREST APIの設計をする際に、値が存在しないという状態をどのように表現するかというお話です。 undefinedとはまずはじめに、ここでundefinedと言っているのは、OpenAPIの仕様において、リクエスト/レスポンスのデータ型を定義するSchema Objectのプロパティの1つであるrequiredが指定されていない状態を指します。 OpenAPIにおけるrequiredの定義を確認してみましょう。 OpenAPIの仕様を参照すると、Schema ObjectはJSON Schemaの仕様に従うと記載されています。 The Schema Object allows the definition of input and output data types. These types can be objects, but also primit
OpenAPI定義をmswに活用してお手軽モック
Leaner 開発チームの黒曜(@kokuyouwind)です。 RubyKaigi Takeout 2021真っ只中ですね。自分も視聴して実況ツイートを垂れ流しています。 でも今回はフロントエンドの話です。 TL;DR OpenAPI 定義を JSON で記述しておくと、 import schema from 'schema.json' で読み込んで Component などの定義を参照できます。 これを使って msw の Handler を定義すると、簡単に API をモックしてテストできるので便利です。 異常系のハンドラーも同じところで定義しておくと、テスト時のレスポンス差し替えもシンプルになって読みやすくなります。 OpenAPI 定義を msw に使いたい 以前書いたとおり、現在自分が担当しているプロダクトでは OpenAPI を使って API スキーマを定義しています。 このス
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
