AWS CDKを使ってAPI Gateway(HTTPAPI)+LambdaをOpenAPIで定義してデプロイする | ブログ | Serverless Operations
>_cd /blog/id_347 development technology#Amazon API Gateway#AWS Cloud Development Kit#AWS LambdaDate2021-03-13Time00:00:00 JST OpenAPIを使ってAPIの定義を行い、API GatewayのOpen API定義のインポート機能を使って行うのは、AWSでREST APIを開発する際のポピュラーなやり方ではないでしょうか。本記事ではAWS CDK(TypeScript)を使ってAPIGateway(HTTP API)とLambdaで構成されたAPIをOpenAPIの定義ファイルを使ってインポートしデプロイする方法です。 実際のソースコートは以下に上がっていますのでこちらもご参考に。 https://github.com/serverless-operations/c
TypeScriptプロジェクトにスキーマ駆動開発を持ち込み、より型安全な世界へ - Sansan Tech Blog
Bill One Entry*1グループの秋山です。 本題に入る前にお知らせです。9/12 (火) にTypeScriptを活用した型安全なチーム開発をテーマとしたイベントを開催します。 ぜひ、お気軽にご参加ください！ sansan.connpass.com 1. はじめに 1-1. スキーマ駆動開発とは 1-2. Testing Trophyとの関係性 2. 構成 2-1. 最初の構成と課題 2-2. 最終的な構成 3. バックエンド 3-1. スキーマから型ファイルを作る 3-2. APIハンドラに型を与える 3-3. バリデーターを追加する 3-4. huskyでスキーマ変更を検知する 4. フロントエンド 4-1. スキーマからAPIクライアントを作る 5. パターンマッチングを持ち込む 6. まとめ 1. はじめに 1-1. スキーマ駆動開発とは 詳しい解説は他の記事に譲り、一言
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
OpenAPI GeneratorでPython Web API構築 | フューチャー技術ブログ
この記事はPython Advent Calendar 2022 カレンダー2の3日目です。昨日はtttakehさんのじゃんけん画像を分類してみたでした。 はじめにこんにちは。TIG DXユニットの村上です！ さて、私の所属しているプロジェクトではバックエンドシステムに主にGo言語を用いており、Go言語によるWebAPIを構築しています。 例えばLambdaとGoを使ったサーバーレスWebAPI開発実践入門など、Future Tech Blogには多くのノウハウが投稿されていますので是非ご覧になっていただければと思います。 今回はGo言語ではなくPythonでWebAPIを構築しました。その際にOpenAPI Generatorが便利だったのでご共有します。 OpenAPI GeneratorOpenAPI GeneratorはAPIリクエストやレスポンスの内容を定義し、それを元にプログラ
OpenAPI の定義を Stoplight Studio で書く
こんにちは、 Gaji-Labo アシスタントエンジニアの石垣です。 今回は OpenAPI の定義ファイルを Stoplight Studio で書く機会があったため、自身の理解を深めるためにも OpenAPI と Stoplight Studio についてまとめてみます。 OpenAPIとは？OpenAPI は、REST APIの定義を記述するためのフォーマットである「OpenAPI Specification」の略称です。元々「Swagger」という REST API を設計、構築、文書化、および使用などを行うためのフレームワークが存在し、そこで用いられていたフォーマットが標準化されたものが OpenAPI のようです。 スキーマ駆動開発で分離されているバックエンドとフロントエンドの実装を繋ぎこむために OpenAPI が用いられます。 OpenAPI の定義は JSON や YAM
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
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
OpenAPI (Swagger) 超入門 - Qiita