Dokumentacja interfejsu API REST konstruktora interfejsu API danych za pomocą programu Swagger/OpenAPI
Specyfikacja interfejsu OpenAPI jest niezależnym od języka programowania standardem do dokumentowania interfejsów API PROTOKOŁU HTTP. Konstruktor interfejsu API danych obsługuje standard OpenAPI z możliwością wykonywania następujących zadań:
- Generuj informacje o wszystkich jednostkach zdefiniowanych w konfiguracji środowiska uruchomieniowego, które są włączone w architekturze REST.
- Skompiluj informacje w formacie zgodnym ze schematem interfejsu OpenAPI.
- Uwidacznia wygenerowany schemat interfejsu OpenAPI za pośrednictwem wizualnego interfejsu użytkownika (Swagger) lub serializowanego pliku.
Dokument opisu interfejsu OpenAPI
Konstruktor interfejsu API danych generuje dokument opisu interfejsu OpenAPI przy użyciu podanej konfiguracji środowiska uruchomieniowego i metadanych obiektu bazy danych dla każdej zdefiniowanej jednostki z obsługą interfejsu REST. Plik schematu jest generowany przy użyciu funkcji udostępnianych przez zestaw SDK OpenAPI.NET. Obecnie plik schematu jest generowany zgodnie ze specyfikacją Interfejsu OpenAPI w wersji 3.0.1 sformatowaną jako JSON.
Dokument opisu interfejsu OpenAPI można pobrać z konstruktora interfejsu API danych ze ścieżki:
GET /{rest-path}/openapi
Uwaga
Domyślnie rest-path wartość jest api i można jej konfigurować. Aby uzyskać więcej informacji, zobacz Konfiguracja REST
SwaggerUI
Narzędzie Swagger UI oferuje internetowy interfejs użytkownika, który udostępnia informacje o usłudze przy użyciu wygenerowanej specyfikacji interfejsu OpenAPI.
W Development trybie konstruktor interfejsu API danych umożliwia wyświetlanie wygenerowanego dokumentu opisu interfejsu OpenAPI z dedykowanego punktu końcowego:
GET /swagger
Punkt końcowy "Swagger" nie jest zagnieżdżony w rest-path obszarze , aby uniknąć konfliktów nazewnictwa ze skonfigurowanymi jednostkami środowiska uruchomieniowego.