Swaggerツールの使用方法

2年 ago
優斗, 朝陽
1 minute

Swaggerツールとは、RESTful APIの構築、ドキュメント化、テストを行うためのツールです。Swaggerツールの使用方法を以下に示します。

  1. Swaggerツールのインストール：Swaggerコマンドラインツールをnpm経由でインストールできます。端末で以下のコマンドを実行してインストールします：
npm install -g swagger
  1. Swaggerプロジェクトを作成する：対象のSwaggerプロジェクトを作成するディレクトリへターミナルで移動し、以下のコマンドを実行して下さい。
swagger project create <project-name>

新規の Swagger プロジェクトを作成し、指定のディレクトリにプロジェクトファイルを生成します。

  1. ネイティブに翻訳された日本語のセンテンスを一つだけ: api/swagger/swagger.yaml
swagger: "2.0"
info:
title: "API Title"
version: "1.0.0"
paths:
/path:
get:
summary: "Description of GET endpoint"
responses:
200:
description: "OK"

API定義には、パス、リクエストメソッド、パラメータ、レスポンスなどが含まれます。

  1. Swaggerプロジェクトの実行：端末でSwaggerプロジェクトのディレクトリに移動し、以下を実行します。
swagger project start

これによりSwaggerプロジェクトが起動し、APIドキュメントとSwagger UIインターフェースがデフォルトでブラウザからアクセスできるようになります。

  1. http://localhost:3000/ドキュメント

Swaggerツールの基本的な使用方法を以下に示します。より詳細な使用方法や設定オプションについては、Swaggerの公式ドキュメントを参照してください。

bannerAds