ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Web APIを綺麗に設計するのはとても大変です。リソース名の決め方一つとってもそうですし、単純にCRUD操作だけで済まない場合のアクション名をどう指定するか、HTTPメソッドを何にするかといった問題もあります。

今回紹介するStoplight StudioはWeb APIのデザイン、ドキュメント整備を一括して行えるエディタです。

Stoplight Studioの使い方

まず組織、そしてプロジェクトを作成します。

リファレンスを作成します。ドメインを指定します。

APIキーベースの認証などを指定できます。

パスを設計します。

エクスポート機能があります。

ドキュメント。

OASベースのYAMLでも内容を編集できます。

プレビューもあります。

Stoplight Studioを使うことでWeb APIの設計が統一感を持ってスムーズに行えそうです。決めるべき、設計すべき項目も分かりますし、ドキュメントとの紐付けも容易です。RESTfulなWeb APIを設計する際にぜひ使ってみましょう。

Stoplight StudioはWeb/macOS/Windows/Linux用のソフトウェアです。

Stoplight Studio | OpenAPI Design, Planning & Modeling Tool

stoplightio/studio: The modern editor for API Design and Technical Writing.

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2