Swagger Documentation with wrong module prefix

Support
,
#1

Hi team,

I’ve installed rest-api addon, then I found swagger json or yaml generated with wrong module prefix(base url). My project module prefix is test, but the url is with the default name “app”.

e.g. http://localhost:8080/**app**/rest/v2/userInfo

I’ve tested 2 versions,

7.2.1: Cannot get json but only yaml, with wrong module prefix
7.1.2: Can get both json and yaml, with wrong module prefix

please kindly advise if something i missed to configure or there’s a bug?

thank you very much

#3

Hi,

The /rest/v2/docs/swagger.yaml and /rest/v2/docs/swagger.json endpoints return a generic REST API documentation. It is always the same file that is displayed here: Swagger UI

If you need a project-specfic swagger documentation that takes you application name into account, then you must use these endpoints:

  • /rest/v2/docs/swaggerDetailed.yaml
  • /rest/v2/docs/swaggerDetailed.json

See REST API documentation.

1 Like
#4

understood, many thanks!