OpenAPIのご紹介
2017/08/23
  • このエントリーをはてなブックマークに追加

ソフトウェアエンジニアの和田です。今回は、弊社カブクでも利用しているOpenAPIについてご紹介したいと思います。


OpenAPI Specのv3は7月にリリースされたばかり


OpenAPI Specification (OAS) とは

OpenAPI Speficification (以下、OAS)とは、APIを記述するためのフォーマットであり、Open API Initiativeによって推進されてるオープンな規格です。仕様の管理や議論にはGitHubが使われており、OASの内容はGitHubのリポジトリから参照できます。OASに則りAPIを記述するために作成されたドキュメントは「OpenAPIドキュメント」と呼ばれ、JSON/YAMLの2つのフォーマットで記述が可能です。


ちなみに、2017年7月にOASの最新バージョンv3.0.0がリリースされたばかりですが、本記事では現在最も使われているであろうv2.0の内容でご紹介致します。


また、OpenAPI Specificationの旧名はSwagger Specificationであり、Swaggerの名称でご存じの方も多いでしょう。現在でもSwaggerという名称とOpenAPIという名称が混じって使われていたりはするのですが、基本的には同じ意味と捉えていただいて、問題ありません。


OpenAPIって何に使うの?

OpenAPIを利用するケースをご紹介致します。

1. APIのドキュメントとして

OpenAPIドキュメントを作成することで、APIの仕様を統一されたフォーマットで記述できるため、OASに慣れた開発者間でのAPI仕様のやり取りをスムーズに行うことができます。また、Swagger UIを使用すれば、JSONやYAMLで記述されたAPIのドキュメントを見やすいドキュメントとして閲覧することもできます。


2. 自動コード生成ツールとして

Swagger Codegenを使用すると、APIに関連するプログラムを自動で生成することが出来ます。Swagger Codegenは、多くの言語(C++, C#, Clojure, Dart, Groovy, Go, Java, Kotlin, Javascript, Objective-C, Perl, PHP, Python, Ruby, Scala, Swift, TypeScriptなど)に対応しており、主要な言語のAPIクライアントやStubサーバ(モックサーバ)を自動生成できます。

また、AngularやAnuglarJSといったフレームワークに対応したAPIクライアントも生成可能であり、弊社カブクにおいてもこのコード生成機能を利用して、Anuglarを利用した開発を実施しています。


OpenAPIの使用例

たとえばSwagger Codegenで使用されているOpenAPIドキュメントはこちら(JSON, YAML)から閲覧することができます。このYAMLをたとえばSwaggerUIで表示すると、 こちらのように閲覧することができます。


Swagger UIで表示した様子

また、Swagger Codegenで生成されたAPIクライアントやStubサーバのサンプルは、こちらから参照することが可能です。

Swaggerの公式サイトでは、非常に多くの多くOpenAPIを利用したツールが紹介されています。多数の言語、フレームワークに対応したツールが紹介されているので、皆様のプロジェクトで利用可能なツールを見つけることができるかもしれません。


もう少し詳しい使用例

もう少し詳しくみてみましょう。次のようなOpenAPIのドキュメントで定義されるAPIを考えてみます。このOpenAPIドキュメントではBookというリソースと、/books(GET,POST)と/books/{id}(GET,PUT,DELETE)という2つのAPIエンドポイントを定義しています。

サンプルのOpenAPIドキュメント

swagger: '2.0'
info:
  title: Book Store
  description: API for Book Store
  version: 1.0.0
host: book-store.kabuku.co.jp
basePath: /api/v1
schemes:
  - http
  - https
consumes:
  - application/json
produces:
  - application/json

paths:
  /books:
    get:
      tags: [Books]
      summary: 本の一覧取得
      description: これまでに登録されている本の一覧を取得します
      operationId: getBooksList
      responses:
        '200':
          description: successful operation
          schema:
            title: books
            type: array
            items:
              $ref: '#/definitions/Book'
    post:
      tags: [Books]
      summary: 本の登録
      description: 渡されるパラメータに基づいて、新しい本を登録します
      operationId: createBook
      parameters:
        - name: book
          in: body
          description: book parameter
          required: true
          schema:
            $ref: '#/definitions/Book'
      responses:
        '200':
          description: successful operation
          schema:
            title: book
            $ref: '#/definitions/Book'

  /books/{id}:
    parameters:
      - name: id
        in: path
        description: book id
        required: true
        type: integer
        format: int64
    get:
      tags: [Books]
      summary: 本の詳細取得
      description: 指定されたidに該当する本の詳細情報を取得します
      operationId: getBookById
      responses:
        '200':
          description: successful operation
          schema:
            title: book
            $ref: '#/definitions/Book'
    put:
      tags: [Books]
      summary: 本の詳細更新
      description: 指定されたidに該当する本の詳細情報を、渡されるパラメータに基づいて、更新します
      operationId: updateBook
      parameters:
        - name: book
          in: body
          description: book parameter
          required: true
          schema:
            $ref: '#/definitions/Book'
      responses:
        '200':
          description: successful operation
          schema:
            title: book
            $ref: '#/definitions/Book'

    delete:
      tags: [Books]
      summary: 本の削除
      description: 指定されたidに該当する本を削除します
      operationId: deleteBook
      responses:
        '204':
          description: successful operation

definitions:
  Book:
    type: object
    required: [id, title, author, release_date]
    properties:
      id:
        type: integer
        description: 本を識別する一意のID
        readOnly: true
        example: 1
      title:
        type: string
        description: 本のタイトル
        example: 初めてのThree.js 第2版 ―WebGLのためのJavaScript 3Dライブラリ
      author:
        type: string
        description: 著者名
        example: Jos Dirksen
      translator:
        type: string
        description: 翻訳者
        example: あんどうやすし
      release_date:
        type: string
        format: date
        description: 発売日
        example: 2016-07-23
      url:
        type: string
        format: uri
        description: 本のURL
        example: https://www.amazon.co.jp/dp/4873117704


Swagger UIを用いた表示

このOpenAPIドキュメントをSwagger UIで表示してみると、こちらのように見ることが出来ます。

下記はiframeを使用してこのページに埋め込んだ表示例です。Swagger UIからは実際にAPIをコールすることも可能です(ただし下記の例では、APIサーバを実際には建てていないので、APIコールしてもエラーとなります)


Swagger CodegenによるAPIクライアントの自動生成

Swagger Codegenを使用してAPIクライアントを自動生成してみましょう。Swagger CodegenはHomebrewに対応しているので、Macの場合にはbrew install swagger-codegenでインストールすることが可能です。

次のようにコマンドを実行すると、openapi.yamlをOpenAPIドキュメントとして、clientディレクトリ以下にPythonクライアントが生成することが可能です。この中のswagger_clientパッケージが、APIクライアントのコードとなります(このパッケージ名は生成時の設定で変更できます)。

swagger-codegen generate -i openapi.yaml -l python -o client

.
├── README.md
├── docs
│   ├── Book.md
│   └── BooksApi.md
├── git_push.sh
├── requirements.txt
├── setup.py
├── swagger_client
│   ├── __init__.py
│   ├── api_client.py
│   ├── apis
│   │   ├── __init__.py
│   │   └── books_api.py
│   ├── configuration.py
│   ├── models
│   │   ├── __init__.py
│   │   └── book.py
│   └── rest.py
├── test
│   ├── __init__.py
│   ├── test_book.py
│   └── test_books_api.py
├── test-requirements.txt
└── tox.ini

実際に/booksに対してGETリクエストを送るには、下記のようなコードを記述すればOKです。ちなみにこのような生成されたAPIクライアントの使い方のドキュメントも自動生成されます。この例では、docsディレクトリ以下のMarkDownドキュメントが使用例のドキュメントです。

from __future__ import print_function
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.BooksApi()

try:
    # 本の一覧取得
    api_response = api_instance.get_books_list()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling BooksApi->get_books_list: %s\n" % e)

非常に簡単に使えることがお分かりいただけましたでしょうか?もちろんPython以外の言語にも対応しているので、ご自身のプロジェクトに合わせたAPIクライアントの生成が可能です。

APIに関連するコードは似たようなコードが多い割に、意外と手間がかかったりするので、このような自動生成を上手く利用することで、工数を劇的に削減できる場合も多いでしょう。

最後に

今年のEuroPython2017で、 「OpenAPI development with Python」という内容で講演しました。より細かい内容が気になる方は、是非スライドもご覧ください。ちなみにこの講演後、「OpenAPIの採用を決めた!」と報告してくれた開発者の方がいてちょっと嬉しかったです。



また、8/30に弊社オフィス(新宿)にて、 EuroPython2017の報告会を行う予定です。EuroPython2017には僕を含めた2名が発表者として参加しており、私達の発表内容と気になった発表のご紹介を行う予定です。

また、 今年のPyConJP 2017でも 「OpenAPIを利用したPythonWebアプリケーション開発」という内容で講演する予定(9/9土 10:55AM–11:25AM in Room 202@早稲田大学西早稲田キャンパス63号館)です。OpenAPIの基本的な内容から開発事例までご紹介する予定です。PyConJPに参加する方、是非いらしてください。

ちなみに本記事の最初に記述したように最近OASv3がリリースされており、非常に有用な機能(v2までで歯がゆく思っていた部分の改善)が追加されています。この辺についても、このブログで紹介していく予定ですのでご期待下さい!