Is it possible to get a schema, swagger OAS, or a postman collection for all API endpoints?

Completed

Comments

7 comments

  • Avatar
    Evgeny Balashov

    Hi Luke! 

    It is not available for the existing API, but we have a new REST API with OpenAPI (swagger) schema in baking. 

    The preview will become available in Meta around February-March, and planned to be in production release later this year.

    0
    Comment actions Permalink
  • Avatar
    Evgeny Balashov

    For the existing API a description of methods is available in our legacy format at http://{SERVER IP}:7001/static/api.json, but we know that the format is lacking structure for non-trivial methods.

    0
    Comment actions Permalink
  • Avatar
    francesco cervellera

    Hello.

    Is there any update on this ?

    Thanks

    0
    Comment actions Permalink
  • Avatar
    Norman - Nx Support

    Hi francesco cervellera (and Luke McFadden of course),

    We are trying to fulfill this request in version 5.0.

    You can have a preview with the 5.0 Beta version and use the following URL to access the server API:

    https://localhost:7001/swagger-ui/openapi_deprecated.json
    https://localhost:7001/swagger-ui/openapi_legacy.json
    https://localhost:7001/swagger-ui/openapi_v1.json
    0
    Comment actions Permalink
  • Avatar
    ST team

    Hello all,

    Is there a postman collection of the REST api added by any chance?

    0
    Comment actions Permalink
  • Avatar
    Andrey Terentyev

    Hi Ido Jaffe ,

    Unfortunately, there isn't.

    0
    Comment actions Permalink
  • Avatar
    Loic Lecuyer

    Hello,

    The OpenApi description of your Rest API only concerns your API v1 (deprecated), is there an OpenAPi description of your API V2?

    0
    Comment actions Permalink

Please sign in to leave a comment.