OpenAPI (Swagger) の基本的なあれこれ
2019/03/18 この記事は書かれてから1年以上が経過しており、最新の情報とは異なる可能性があります techAPIOpenAPI 現時点での OpenAPI に関する知識の棚卸しをした方がいいかなと思ったので書きます。 前提使い方が 100% 定まっているわけではありません少なくとも OpenAPI を使っていくこと自体は間違ってないという考えで使っていますGraphQL については触れませんOpenAPI とは何か？ 端的に言うと、 RESTful API に関するインターフェース定義 です。 一方で、そのインターフェース定義は YAML ファイルもしくは JSON ファイルで表されるため、 単なる YAML (JSON) ファイル だということもできると思います。 その仕様に沿って書くことで、周辺ツールであれこれ便利なことができます。 こんな便利なことができる定義ファイルを元にド
Swagger（OpenAPI3.0）に入門する（基本構成編）
この記事は，下記のサイトを参考にしています。 基本構成 OpenAPI の定義は、YAML あるいは JSON で記述することができます。 YAML で書かれた OpenAPI 3.0 の定義のサンプルは、次のようになります。 openapi: 3.0.0 info: title: Sample API description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML. version: 0.1.9 servers: - url: http://api.example.com/v1 description: Optional server description, e.g. Main (production) server - url
Swaggerを使ったAPIドキュメントの作成と、バックエンドとフロントエンド間の連携
こんにちは。LINE Growth Technology福岡開発室でサーバーサイドエンジニアをしている中村です。 この記事では担当していたプロジェクトで実施した、Swaggerを使ったAPIドキュメントの作成と、BE（バックエンド）とFE（フロントエンド）間の連携について紹介します。 プロジェクトの説明 はじめに、今回LINE Growth Technology福岡開発室（以下「GT」）がシステムの設計開発を担当した、LINE公式アカウント審査ツールのプロジェクトについて説明します。 LINE公式アカウント審査ツールとは、LINE公式アカウントで認証済アカウントが申請された際に、申請内容が適切であるか審査するシステムです。 このシステムは、LINE公式アカウントが利用されている各国に存在する審査パートというチーム（以下「審査チーム」）によって利用され、日本以外の国家も含め、一日あたり平均約
スキーマファースト開発のためのOpenAPI（Swagger）設計規約 | フューチャー技術ブログ
はじめまして。TIG DXユニット 1の亀井です。 はじめに みなさん、Swagger使ってますか？ Swaggerや周辺ツールについては 某先輩の記事 にて丁寧に解説されていますので、 本記事では実際にSwaggerのスキーマ定義を設計していく上で取り決めた規約について書いてみたいと思います。 前提私が在籍しているプロジェクトでは、REST APIは golang でフロントエンドを Vue.js + TypeScript で構築しています。 短期間・高品質での構築を実現するためにSwaggerを設計ドキュメントとしてだけではなく、コード自動生成やモックサーバーに活用させることで徹底したスキーマファーストな開発を行ってきました。 というわけで、今回は下記のツールを利用することを前提として規約を作成しています。 go-swagger: Goアプリケーションのハンドラ、リクエスト/レスポンス
OpenAPI (Swagger) を利用して効率よく WebAPI の仕様を管理する
Web 開発の現場でよく耳にする言葉として Swagger というものがあります。アプリケーション開発においてサーバー（WebAPI）とデータの送受信を行う機能は不可欠なものとなっている現在、多くの現場ではそのための設計モデルとして REST (REpresentational State Transfer) という方式が使われています。この記事では、REST API の仕様ドキュメントを記述する手段として OpenAPI (Swagger) というものを紹介し、REST Client 機能を備えたインタラクティブな API 仕様ドキュメントを作成・共有する方法についてお伝えしたいと思います。 OpenAPI (Swagger) とは？OpenAPI Specification (OAS) といい、REST API の仕様を記述するためのフォーマットです。また Swagger とは、Ope
SwaggerをAWS Serverless Application Modelから扱う方法を理解する | DevelopersIO
はじめに こんにちは、中山です。 最近SwaggerをAWS Serverless Application Model(以下AWS SAM)から利用する機会がありました。AWS SAMではAWS::Serverless::ApiまたはAWS::ApiGateway::RestApiリソースを利用することにより、Swagger形式で記述されたファイルを扱うことが可能です。基本的にAWS SAMのみで利用可能な AWS::Serverless::Api リソースを利用することが多いはずです。API Gatewayは複数のリソースに分離されているため、AWS SAMのベースとなっているCloudFromation用のリソースを使うと、テンプレートの行数が長くなってしまうからです。 執筆時点(2017/03/08)では AWS::Serverless::Api リソースはSwaggerファイルを以
Swagger UI + Swagger Editorを使ってAPI仕様書作成を効率化する【Docker】
ツール紹介 17465 view Swagger UI + Swagger Editorを使ってAPI仕様書作成を効率化する【Docker】 最終更新日:2019/03/29 「API仕様書を書かねば、、、、」 誰もがそう思っていたのだった。 そんな思いとは裏腹に、迫りくる納期、限られたリソース、誰かが作ってくれるだろうという淡い期待。 こうしてAPI仕様書は幻と化したのだった。。。 �（完） 、、、ということにはならないようにSwaggerを使ってAPI仕様書を効率よく管理するお話です。 サンプルコード すぐに試してみたい方はこちらから Swaggerとは SwaggerとはRESTful APIを効率よく記述するためのオープンソースフレームワークです。 2015年11月にマイクロソフトやグーグルなどによって結成されたOAI(Open API Initiative)という団体によって採用
(レポート) AWSモバイル/IoTサービス徹底攻略！！ 「Swaggerで始めるモデルファーストなAPI開発」#cmdevio | DevelopersIO
森永です。 11/21（土）に目黒のAWSJにて開催された「AWSモバイル/IoTサービス徹底攻略！！〜Developers.IO Meetup番外編〜」のレポートです！ イベント概要 本勉強会は、基本的な内容のBasic Track、応用的な内容のAdvanced Track、実際に試すことの出来るHands Onの3トラックに分けてAWSのモバイルサービスや、サーバーレスアーキテクチャ、IoTのお話をするというものです。 セッション内容 NRIネットコム（株）佐々木 拓郎さん [slideshare id=55359338&doc=classmethodswagger-151121063232-lva1-app6892] 自己紹介 Amazon Web Servicesパターン別構築・運用ガイドを執筆 AWS関連で一番分厚い本 本の中にクラウドネイティブという名のもとに、クラウドを前提
Swagger 3.0のOAuth認証にCognito User PoolsのOAuth Clientを使う | DevelopersIO
Swaggerとは Swaggerは、RESTful APIを構築するためのオープンソースのフレームワークのことを指します。APIをYAMLで定義でき、実際に呼び出すことができるようなインタラクティブドキュメントを生成できます。Amazon API Gatewayで使われていることでも有名です。 概要については下記のブログを参照してください。 (レポート) AWSモバイル/IoTサービス徹底攻略！！ 「Swaggerで始めるモデルファーストなAPI開発」#cmdevio Swagger 3.0とは Swaggerのバージョンについては、現時点では2系がメジャーですが、3系も正式にリリースされたため、3系で書くケースも増えてきました。なお、API Gatewayは現時点では2系をサポートしています。 3系は、「2系でやりたかったけどできない！」という点が数多く改善され、非常に書きやすくなって
Dockerを使ってSwaggerの環境を整えてAPI Gatewayにインポートする | DevelopersIO
API Gatewayを使いこなしたい そろそろAPI Gateway使いこなしたい今日このごろですが、API Gatewayには、Swaggerの定義ファイルをインポートというボタンがあって、こっちを先にやってみようと思いました。環境周りの整備には以前学んだDockerを使えそうですので、試してみたいと思います。 Swagger Editorで編集する エディタの環境を整えます。 docker pull swaggerapi/swagger-editor docker run -d -p 8001:8080 swaggerapi/swagger-editor ここで作成したJSONとかYAML形式のファイルをエクスポートして保存しておきます。 Swagger UIのインストール Swagger UIは、Swaggerの定義ファイルからキレイな公開用のAPI確認サイトを作ってくれます。 $
【初心者向け】SwaggerとAWS SAMを使ってWebAPIを簡単に作ってみた | DevelopersIO
応答パラメータの例は下記とします。 { "python": "3.6.2" } AWS SAMプロジェクトの準備 下記コマンドでプロジェクト一式を作成します。 sam init --runtime python3.6 --name SwaggerSample Swagger Editor 導入 こちらを参考に導入します。Dockerは便利ですね。 API定義 Swagger Editorで下記を作成しました。この内容をswagger.yamlとして、AWS SAMプロジェクトフォルダに保存します。 swagger.yaml swagger: "2.0" info: description: "SwaggerとAPI Gatewayのサンプルです。" version: "1.0.0" title: "Swagger Sample" basePath: "/Prod" tags: - name
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
OpenAPI (Swagger) 超入門 - Qiita
【連載】Swagger 3.0 入門
swagger_-_api.html