#pkg: "@nocobase/plugin-api-doc"

#API Documentatie

#Introductie

Deze plugin genereert NocoBase HTTP API-documentatie op basis van Swagger.

#Installatie

Dit is een ingebouwde plugin, u hoeft deze niet te installeren. Activeer de plugin om deze te gebruiken.

#Gebruiksaanwijzing

#De API-documentatiepagina openen

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

#Overzicht van de documentatie

• Totale API-documentatie: /api/swagger:get
• Core API-documentatie: /api/swagger:get?ns=core
• API-documentatie voor alle plugins: /api/swagger:get?ns=plugins
• Documentatie per plugin: /api/swagger:get?ns=plugins/{name}
• API-documentatie voor aangepaste collecties: /api/swagger:get?ns=collections
• Specifieke ${collection} en gerelateerde ${collection}.${association} resources: /api/swagger:get?ns=collections/{name}

#Ontwikkelaarsgids

#Swagger-documentatie schrijven voor plugins

Voeg in de src-map van de plugin een bestand swagger/index.ts toe met de volgende inhoud:

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

Voor gedetailleerde schrijfregels verwijzen wij u naar de officiële Swagger-documentatie.