#API ドキュメント

#はじめに

Swagger を利用して、NocoBase のHTTP API ドキュメントを生成するプラグインです。

#インストール

このプラグインは組み込み済みのため、インストールは不要です。有効化するだけで利用できます。

#利用方法

#API ドキュメントページへのアクセス

http://localhost:13000/admin/settings/api-doc/documentation

#ドキュメントの概要

• 全体のAPIドキュメント：/api/swagger:get
• コアAPIドキュメント：/api/swagger:get?ns=core
• すべてのプラグインAPIドキュメント：/api/swagger:get?ns=plugins
• 各プラグインのドキュメント：/api/swagger:get?ns=plugins/{name}
• カスタムコレクションのAPIドキュメント：/api/swagger:get?ns=collections
• 特定の ${collection} および関連する ${collection}.${association} リソース：/api/swagger:get?ns=collections/{name}

#開発者ガイド

#プラグインのSwaggerドキュメントの記述方法

プラグインの src フォルダ内に swagger/index.ts ファイルを以下の内容で追加します。

export default {
  info: {
    title: 'NocoBase API - Auth plugin',
  },
  tags: [],
  paths: {},
  components: {
    schemas: {},
  },
};

詳細な記述ルールについては、Swagger 公式ドキュメントをご参照ください。