#Dokumentacja API

#Wprowadzenie

Wtyczka generuje dokumentację API HTTP NocoBase w oparciu o Swagger.

#Instalacja

Jest to wbudowana wtyczka, więc nie wymaga instalacji. Wystarczy ją aktywować, aby zacząć używać.

#Sposób użycia

#Dostęp do strony dokumentacji API

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

#Przegląd dokumentacji

• Całkowita dokumentacja API: /api/swagger:get
• Dokumentacja API rdzenia: /api/swagger:get?ns=core
• Dokumentacja API wszystkich wtyczek: /api/swagger:get?ns=plugins
• Dokumentacja każdej wtyczki: /api/swagger:get?ns=plugins/{name}
• Dokumentacja API dla niestandardowych kolekcji: /api/swagger:get?ns=collections
• Określone zasoby ${collection} oraz powiązane z nimi zasoby ${collection}.${association}: /api/swagger:get?ns=collections/{name}

#Przewodnik dla programistów

#Jak pisać dokumentację Swagger dla wtyczek

W folderze src wtyczki proszę dodać plik swagger/index.ts o następującej zawartości:

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

Szczegółowe zasady tworzenia dokumentacji znajdą Państwo w oficjalnej dokumentacji Swaggera.