OpenAPI i Data API Builder

OpenAPI-specifikationen är en språkagnostisk standard för att dokumentera HTTP-API:er. Data API Builder stöder OpenAPI genom att:

• Generera metadata för alla REST-aktiverade entiteter som definierats i körningskonfigurationen
• Kompilera dessa metadata till ett giltigt OpenAPI-schema
• Exponera schemat via ett visuellt användargränssnitt (Swagger) eller som en serialiserad JSON-fil

OpenAPI-beskrivningsdokument

Data API Builder genererar ett OpenAPI-beskrivningsdokument med hjälp av körningskonfigurationen och databasmetadata för varje REST-aktiverad entitet.

Schemat skapas med hjälp av OpenAPI.NET SDK och överensstämmer med OpenAPI-specifikationen v3.0.1. Det genereras som ett JSON-dokument.

Du kan komma åt OpenAPI-dokumentet på:

GET /{rest-path}/openapi

[! OBS! Som standard rest-path är är api. Det här värdet kan konfigureras. Mer information finns i REST-konfigurationen .

Swagger-användargränssnitt

Swagger-användargränssnittet ger en interaktiv, webbaserad vy över API:et baserat på OpenAPI-schemat.

I Development läge exponerar Data API Builder Swagger-användargränssnittet på:

GET /swagger

Den här slutpunkten är inte kapslad under rest-path för att undvika konflikter med användardefinierade entiteter.