App::Controllers::SwaggerApiController Klassenreferenz

Klassendiagramm für App::Controllers::SwaggerApiController:

Zusammengehörigkeiten von App::Controllers::SwaggerApiController:

Öffentliche Methoden
	index ()
	HTTP-spezifischer Kontext.
	docs ()
	HTTP-spezifischer Kontext.
Öffentliche Methoden geerbt von App::Controllers::BaseController
	initController (RequestInterface $request, ResponseInterface $response, LoggerInterface $logger)

Weitere Geerbte Elemente
Geschützte Attribute geerbt von App::Controllers::BaseController
	$request
	$helpers = []
	$session

Ausführliche Beschreibung

SwaggerApiController

Controller zur Bereitstellung der Swagger UI und JSON-Dokumentation für die API.

Dokumentation der Elementfunktionen

docs()

App::Controllers::SwaggerApiController::docs

(

)

HTTP-spezifischer Kontext.

Gibt die JSON-Dokumentation der API zurück.

Diese Methode scannt den Controllers-Ordner nach OpenAPI/Swagger-Anmerkungen und gibt die generierte JSON-Dokumentation zurück.

Rückgabe

Namespace: CodeIgniter

JSON-Antwort mit der API-Dokumentation

API-Endpunkt {get} /swagger/docs JSON-Dokumentation abrufen

API Name: \1 SwaggerDocs

API Group: \1 Swagger

API Success: \1 {JSON} openapi JSON-Dokumentation der API

API Error: \1 500 Fehler beim Generieren der Dokumentation

index()

App::Controllers::SwaggerApiController::index

(

)

HTTP-spezifischer Kontext.

Zeigt die Swagger UI an.

Diese Methode lädt die View, die die Swagger Benutzeroberfläche enthält.

Rückgabe

Namespace: CodeIgniter

Die HTML-Antwort mit der Swagger UI

API-Endpunkt {get} /swagger UI anzeigen

API Name: \1 SwaggerUI

API Group: \1 Swagger

API Success: \1 {HTML} Swagger Benutzeroberfläche

---

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

• app/Controllers/SwaggerApiController.php