Initial Support for OpenAPI v3.0.1 description document creation #1462

seantleonard · 2023-04-28T01:08:03Z

Why make this change?

Closes Support for OpenAPI Specification 3.0 #916 by adding support for creating an OpenAPI description document for the Data API builder REST endpoint. https://spec.openapis.org/oas/v3.0.3

What is this change?

Uses Microsoft/OpenAPI.NET to generate an OpenAPI description document for entities defined in the runtime config which are used for the REST endpoint.

How was this tested?

Integration Tests
Unit Tests

Sample Request(s)

https://localhost:5001/swagger -> Swagger UI visualization of generated document.
https://localhost:5001/openapi ->
- [GET] Download/View Generated document

…point.

…, and add GET (all), POST, and PUT,PATCH,DELETE operations and return results

… new route.

src/Service/Services/OpenApiDocumentor.cs

…return http codes

…abled REST

…. added tests.

src/Service.Tests/Configuration/ConfigurationTests.cs

…napi under main restcontroller endpoint, updated logic for openapi, included nextlink

.pipelines/build-pipelines.yml

src/Service/Controllers/RestController.cs

src/Service/Services/OpenAPI/OpenApiDocumentor.cs

src/Service/Services/OpenAPI/SwaggerEndpointMapper.cs

src/Service.Tests/Configuration/ConfigurationTests.cs

…oint, updated openapidocumentor handling of stored procedures and post requests to tables with auto-gen/non-autogen pk consideration in body.

src/Service/Services/OpenAPI/OpenApiDocumentor.cs

Aniruddh25

LGTM, Thanks for implementing the initial support for this most asked feature. Way to go!!

seantleonard added 12 commits April 12, 2023 09:39

Add openAPI package

ec15ee8

Initial openapi service, controller, and mapped swagger ui viewer end…

6773bdd

…point.

Add runtimeconfig to openapidocumentor.

33dafd3

Automate Component Schema creation for Full Entity (with primary key).

55a78e1

additional GET path documenting

8894daf

add openapidoc creation at startup, refine error messages 409 and 500…

9f2c700

…, and add GET (all), POST, and PUT,PATCH,DELETE operations and return results

Consolidated code paths, reduced code verbosity/duplication. Comments.

1488636

updated response codes and formatting of number in openapi doc.

c783106

updated openapicontroller route and updated swaggerUI uri to point to…

81ceda1

… new route.

Remove swagger package, keep swaggerui.

accb50e

added constants and new suberrorcode.

63f0b95

Merge branch 'main' into dev/seantleonard/openapiv3_initial

ca3ca2d

seantleonard commented Apr 28, 2023

View reviewed changes

src/Service/Services/OpenApiDocumentor.cs Outdated Show resolved Hide resolved

updated media type set as application/json for GET endpoint. updated …

2c25653

…return http codes

seantleonard changed the title ~~Initial Support for OpenAPI v3.0.3 description document creation~~ Initial Support for OpenAPI v3.0.1 description document creation Apr 28, 2023

seantleonard added 3 commits April 28, 2023 16:47

prevent entities from being openapi documented if they explicitly dis…

93bebc8

…abled REST

Consolidated code paths, reduced code verbosity/duplication. Comments…

3489ff9

…. added tests.

Merge branch 'main' into dev/seantleonard/openapiv3_initial

ab5d9de

seantleonard marked this pull request as ready for review May 3, 2023 08:03

seantleonard requested review from Aniruddh25, JelteF, Mathos1432, aaronburtle, aaronpowell, abhishekkumams, ayush3797, gledis69, mbhaskar, milismsft and tarazou9 as code owners May 3, 2023 08:03

Merge branch 'main' into dev/seantleonard/openapiv3_initial

dbcf3b5

ayush3797 reviewed May 5, 2023

View reviewed changes

src/Service.Tests/Configuration/ConfigurationTests.cs Outdated Show resolved Hide resolved

seantleonard and others added 7 commits May 5, 2023 15:14

updated custom REST route handling for swagger and openapi, moved ope…

cf7fbe3

…napi under main restcontroller endpoint, updated logic for openapi, included nextlink

updated with dotnet format.

988faaf

fixed tests and controller logic

de2026f

list to hashset to track columns

f1e06b9

allow building notice file in dev.

f77b304

allow building notice file remove conditions.

aaaee4d

Merge branch 'main' into dev/seantleonard/openapiv3_initial

69c5fb0