PostmanでAPIをつくる

# モチベーション
せっかくPostmanでAPIテストをしているので、じゃぁ簡単なAPIをつくってみようかという話
[POSTMAN Learning Center](https://learning.postman.com/)様様です。

# 参考文献
[Using the API Builder](https://learning.postman.com/docs/designing-and-developing-your-api/the-api-workflow/)

# 手順
PostmanにはAPI builderという機能があるらしい

#### （空っぽの）APIをつくる
Postman Desktop App の左ペーンよりAPIsを選択　→　メニュー内のCreate an APIをクリックする
![postman_create1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/80269051-8396-1253-25a2-b4570532b73a.png)
モーダルが表示されるので、基本情報を入力・選択しCreate APIボタンをクリックする

| API名 | バージョン | スキーマ | スキーマのフォーマット |
|:-:|:-:|:-:|:-:|
| my-first-api  | 1.0.0  | OpenAPI 3.0  | JSON  |
![postman_create2.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/f492ce20-6824-d98c-7a89-7361db88a36e.png)

↓↓のような感じになったら、とりあえずOKだと思う：
![postman_create3.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/6c6e5512-45f9-4d91-dfa9-3f13f2a00a59.png)

#### APIを定義する
APIを定義する。Postmanには、定義したAPIから自動でcollectionを生成する機能もあるみたい、すごい。

##### APIを編集する
作成したAPIの仕様は、Defineタブに記載するみたい。
今回はOpenAPI 3.0をスキーマとして設定したため、PostmanがサンプルのAPI仕様を作ってくれている。
編集したら、Saveボタンをクリックして保存する。
![postman_create4.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/7a0cae96-2753-0c0f-d3d6-07c687355144.png)

<details><summary>Defineタブにデフォルトで入力されるAPI仕様</summary><div>

```sample-spec.json
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "my-first-api",
    "license": {
      "name": "MIT"
    }
  },
  "servers": [
    {
      "url": "http://petstore.swagger.io/v1"
    }
  ],
  "paths": {
    "/user": {
      "get": {
        "summary": "Details about a user",
        "operationId": "listUser",
        "tags": [
          "user"
        ],
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "ID of the user",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Details about a user",
            "headers": {
              "x-next": {
                "description": "A link to the next page of responses",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/User"
                }
              }
            }
          },
          "default": {
            "description": "unexpected error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "User": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int64"
          },
          "name": {
            "type": "string"
          },
          "tag": {
            "type": "string"
          }
        }
      },
      "Error": {
        "type": "object",
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}
```
</div></details>

##### 作成したAPIからcollectionを生成する
作成したAPIのドキュメントを書きたい、テストを書きたい、モックサーバーを書きたいという場合は、Generate Collection機能を使用する。

ウィンドウ右側にGenerrate Collectionボタンがあるのでクリックする：
![postman_create5.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/9deabf7a-1822-eb0c-dac2-6af80073e8b8.png)
モーダルが表示されるので、Collection名を入力し、用途を選択する：
![postman_create6.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/476f84fe-caac-79af-c4cf-0e095dc75c84.png)
Generate Collectionボタンをクリックすると、collectionが生成される。
今回は、用途として「Test the API」を選択した：
![postman_create7.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/77762/a0b4e029-0e19-76e8-881c-004cfba23fc7.png)

# 備考
モックサーバーをつくることはできるが、呼び出し回数には制限がある（無料プランだと、月間1,000回まで）。
現在の呼び出し回数は、Add-onsから確認できる：
https://web.postman.co/billing/add-ons/overview