#API-dokumentation

#Introduktion

Detta plugin genererar NocoBase HTTP API-dokumentation baserat på Swagger.

#Installation

Detta är ett inbyggt plugin, så ingen installation krävs. Aktivera det bara för att börja använda det.

#Användningsinstruktioner

#Åtkomst till API-dokumentationssidan

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

#Dokumentationsöversikt

• Total API-dokumentation: /api/swagger:get
• Kärn-API-dokumentation: /api/swagger:get?ns=core
• API-dokumentation för alla plugin: /api/swagger:get?ns=plugins
• Dokumentation för varje plugin: /api/swagger:get?ns=plugins/{name}
• API-dokumentation för anpassade samlingar: /api/swagger:get?ns=collections
• Specificerade ${collection} och relaterade ${collection}.${association} resurser: /api/swagger:get?ns=collections/{name}

#Utvecklarguide

#Hur man skriver Swagger-dokumentation för plugin

Lägg till en swagger/index.ts-fil i pluginets src-mapp med följande innehåll:

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

För detaljerade skrivregler, se Swaggers officiella dokumentation.