メモ > 技術 > 開発: Swagger > 入門
入門
以下が分かりやすくて情報も新しいので参考になる
OpenAPI (Swagger) 超入門 - Qiita
https://qiita.com/teinen_qiita/items/e440ca7b1b52ec918f1b
Swaggerの記法まとめ - Qiita
https://qiita.com/rllllho/items/53a0023b32f4c0f8eabb
基本的にはオンラインツールで作業できる
Swagger Editor に以下を入力すると、画面右側に Swagger UI の結果が表示される
（ただし「VSCodeでの起動」で紹介するように、ローカルで扱えるツールを導入する方が良さそう）
以下はごく簡易なAPIの例
openapi: "3.0.0"
info:
title: "アプリAPI"
version: "1.0.0"
servers:
- url: "https://example.com/api/{version}"
description: "Mobile App API Server"
variables:
version:
default: "v1"
paths:
"/healthcheck":
post:
tags:
- "User"
summary: "接続テスト用"
parameters: []
responses:
"200":
description: "接続テストの結果を返す"
content:
"application/json":
schema:
type: "object"
properties:
message:
type: "string"
example:
message: "OK"
"/users":
get:
tags:
- "User"
summary: "すべてのユーザを取得"
parameters: []
responses:
"200":
description: "ユーザオブジェクトの配列を返す"
content:
"application/json":
schema:
type: "array"
items:
$ref: "#/components/schemas/User"
"/user/{userId}":
get:
tags:
- "User"
summary: "指定したユーザを取得"
parameters:
- name: "userId"
in: "path"
required: true
schema:
type: "integer"
responses:
"200":
description: "ユーザオブジェクトを返す"
content:
"application/json":
schema:
type: "object"
items:
$ref: "#/components/schemas/User"
components:
schemas:
User:
type: "object"
required:
- "id"
properties:
id:
type: "integer"
name:
type: "string"