Open API JSON document for the Rest API

General Discussion
1

Is there an available OpenAPI JSON document that can be used for the API?

Our company leverages these documents to auto-generate integration code.

2

Just to confirm, are you asking if Feathery has a published OpenAPI/Swagger JSON file that describes all available API endpoints?

3

Yes, is that available?

4

Even though I couldn’t find any documentation, I did try the following list of common OpenAPI endpoints – but of course I didn’t find anything.

  • /openapi.json
  • /swagger.json
  • /api/schema/
  • /api/schema/?format=openapi
  • /schema/
  • /docs
  • /api/docs
  • /redoc
  • /api/redoc
  • /swagger/v1/swagger.json
5

If you are looking for the available APIs, you can take a look at here.

6

Yes, I have seen that, but without the OpenAPI spec we have to manually write all the code to communicate with the APIs.

Is there a reason why there isn’t an available OpenAPI definition?

7

@Kenny - I’ve gone ahead and created this library/NuGet package for anyone wanting to integrate with Feathery in .NET.

1 Like
8

Hi @ft_heale ,

This OpenAPI document will surely be a part of our roadmap. Thank you for your contribution to the community!