openapi

OpenAPIの$refにdescriptionをつける苦肉の策

例えば以下のようなschemaがあるとする。このperson中のfather,motherは同じschemaのpersonを参照する形になっている。 { "components": { "schemas": { "person": { "type": "object", "properties": { "name": { "type": "string" }, "age": { "type": "in…

reflect-openapiにswagger-uiを組み込んだ

github.com この記事の続き。いろいろ変更を加えてswagger-uiを組み込んだ。 goで作られた既存のweb APIに後付けでopenAPI docを付けたかった これまでのreflect-openapi 以下のような "Hello " と返すだけの関数を公開する。 type HelloInput struct{ Name …

goで作られた既存のweb APIに後付けでopenAPI docを付けたかった

github.com 最近、reflect-openapiというパッケージを作っています。まだまだ荒削りですがある程度動く感じにはなったので紹介します。 goで作られた既存のweb APIに対してopenAPI docが見れるようにしたい、というの作りはじめた動機です。 なんで新しく作…

pythonの型定義を使ってOpenAPI docを出力してみる。

今回は以前のprotobufの出力を試した記事のOpenAPI doc版。 pythonの型定義を使ってprotobufを出力してみる。 近年のOpenAPIの状況 近年では、openAPIとの付き合い方もだいぶ落ち着いてきて、夢を見た機能を実装し切るというような気持ちのところは減ってき…

jsonschema/OpenAPI Specでのstrictなschema定義の大変さとPolicy as Codeについて

なんとなく自分の中でのopenAPIについての総括的な行いをしたくなってきた。ちなみに雑感的なものは最近tweetした。ただし今回はその手前でschemaに関する事柄についてまとめてみようと思った。 jsonschemaとOpenAPI Spec ここで言及しているjsonschemaとOpe…