#Dokumentace API

#Úvod

Tento plugin generuje dokumentaci NocoBase HTTP API na základě Swaggeru.

#Instalace

Jedná se o vestavěný plugin, který nevyžaduje instalaci. Stačí jej aktivovat a můžete jej začít používat.

#Pokyny k použití

#Přístup ke stránce dokumentace API

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

#Přehled dokumentace

• Celková dokumentace API: /api/swagger:get
• Dokumentace základního API (Core API): /api/swagger:get?ns=core
• Dokumentace API všech pluginů: /api/swagger:get?ns=plugins
• Dokumentace pro každý plugin: /api/swagger:get?ns=plugins/{name}
• Dokumentace API pro vlastní kolekce: /api/swagger:get?ns=collections
• Dokumentace pro konkrétní ${collection} a související zdroje ${collection}.${association}: /api/swagger:get?ns=collections/{name}

#Průvodce pro vývojáře

#Jak psát Swagger dokumentaci pro pluginy

Do složky src pluginu přidejte soubor swagger/index.ts s následujícím obsahem:

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

Podrobné pokyny k psaní naleznete v oficiální dokumentaci Swaggeru.