ゼロからOpenAPIを始めた話 - NRIネットコムBlog
はじめに OpenAPIとは SwaggerでAPIを設計する OpenAPIのフィールド openapi info externalDocs servers tags paths components おわりに はじめに こんにちは、山田です。最近少しだけ涼しいと感じる反面、シャーベット系のアイスにハマり始めています笑。 入社してから3ヶ月が経過して、ようやく慣れてきました。 本記事は入社して2本目の記事で、今回は研修で学んだAPIドキュメント作成の話です。研修ではショッピングサイトのAPI作成に取り組んだのですが、想像以上にドキュメント作成に苦戦をしたので整理もかねて書いています。 OpenAPIとは OpenAPIとは「OpenAPI Specification」の略でREST APIのコードやドキュメントを生成できるフォーマットのことを指します。API仕様書はExcelで作成すると
Open API はじめました
始めに こんにちは。株式会社ペライチ のサーバーサイドエンジニアの永見です。 開発プロセスに Open API を導入しました。ここにその知見を書いておきます。 背景 ペライチではメインのサイト作成サービスの他に、予約や顧客管理などさまざまなサービスを扱っています。各サブサービスはマイクロサービス化しており(全部ではないけど)、Web API サーバとして稼働しています。 開発の課題として以下がありました。 課題 1 : 実装とドキュメントが一致していない API の設計を Git 外のドキュメントに記載していた まったく記載がないよりはマシですが、どうしてもメンテナンスが後手になり、 実装と乖離している状態が定常化していました。 課題 2 : フロントエンドとバックエンドの連携 開発メンバーが増え、メンバー一人でバックとフロントの両方を受けもつことが少なくなり、 フロントエンドとバックエ
OpenAPIとは一体何なのか調べたのでMEMO - Madogiwa Blog
最近、バックエンドはRails(APIモード)、フロントはNuxt.jsといったフロントエンドとバックエンドが別々で、APIでやり取りさせるような構成が多くなってきました。 そういう場合にバックエンドとフロントエンドのIF(スキーマ)を管理するのにOpenAPIというのがデファクトスタンダードになりつつあるようです。 自分自身、普通のモノリシックなRailsアプリケーションしか触ったことがなかったので、この辺キャッチアップできてなかったのですが、いろいろ環境とか作ったりしてなんとなく分かってきたので、メモしておきます📝 OpenAPIとは OpenAPIとはもともとSwaggerと呼ばれるツールによって定義されたRESTfulなAPIの定義方法が標準化されてもののようです。 The OpenAPI Specification, formerly known as the Swagger
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
