30
We can generate an OData EDMX file (On premise)
https://bcurl:7048//api////$metadata

I can't see how to generate an OAS file, despite the release notes for 2019 wave 1 indicating that this will be possible https://docs.microsoft.com/en-us/business-applications-release-notes/april19/dynamics365-business-central/standard-web-apis#open-api-specification-3x

It appears that Microsoft is providing a yaml file for the standard api https://docs.microsoft.com/en-au/dynamics-nav/api-reference/v1.0/dynamics-open-api but that obviously won't work for custom apis.

I would like a way to generate a yaml or json file in an Open API format for custom apis that can then be imported into swagger or similar for documentation purposes.
Category: Development
STATUS DETAILS
Needs Votes
Ideas Administrator

Thank you for this suggestion! Currently this is not on our roadmap. We are tracking this idea and if it gathers more votes and comments we will consider it in the future.

Best regards,
Business Central Team

Comments

D

When we work with other Technologies Teams in BC integration projects, they can't believe that Business Central API cannot be auto-documented and tested via Swagger...At that time, as developers, we feel that we still do not work with a truly modern environment at the level of integrations with third parties.

Category: Development

D

EDMX url
https://bcurl:7048/(instance)/api/(publisher)/(group)/(version)/$metadata

Category: Development