タグ: Swagger

API

Swagger API(REST API)とDB定義チェック表

  API・DB設計でレビュー頂いた数々を大公開…。😭😭😭   Swagger Editor API設計     現在要件にないものはAPI設計に含めない YAGNIの法則。 将来の拡張を見越して作っておいちゃえ!っと含めるとアプリ開発側で謎のエンドポイントや属性になる😥 → 現在の要件のみAPI設計に含める   キャメルケース、パスカ …

RDB, SEノウハウ

DB, API設計でのINT型

  DB, API設計でのINT型留意点 データベース設計の正規化ではnullは不許可 WorkBenchのフラグ欄を真偽値型のBoolean(TINYINT)を選択する Swagger Editor ・真偽値はtypeをbooleanにする ・21億4,000万 ・超える可能性がある →BIGINT ・超えない → INT32 自動採番の主キーはBIGINT(INT64)にしています。 …

API

ポケモンで学ぶSwagger(OpenAPI)

  Swagger Editor   openapi3系で書きます   バージョン違うとエラーが出ます。 最新で頑張るのだ!(。- .•)   Swagger EditorでDeleteを定義したけれど、delete_flg, invalid_flgといった論理削除や論理無効化で処理することが多いっぽい。だから実践ではDeleteメソッドは利用せず、PUTメ …

API

OpenAPI(Swagger)のお勉強

Swaggerをやる必要がでてきた。それもすぐ。 フロントとバックエンドで別れているAPI開発で、仕様書 からコード生成してレスポンスを返すモックサーバを作ってくれる。そのツールがSwagger Tools。     お勉強しながらまとめます(。- .•)     Swagger導入のメリット フロントとバックエンドで別れているチームで効果を発揮する。 AP …