Hi, quick question Swagger shows `/health`, but ...
# introductions
g
Hi, quick question Swagger shows
/health
, but it only works as
/api/health
locally. Is the
/api
prefix missing from the OpenAPI schema, or am I setting something up incorrectly?
n
hi @Gufran khan_India - these docs might be useful https://docs.prefect.io/v3/api-ref/rest-api#rest-guidelines in particular
The API is hosted with an
/api/:version
prefix that (optionally) allows versioning in the future. By convention, we treat that as part of the base URL and do not include that in API examples.
👍 1
g
Thanks, that makes sense now. I was treating
127.0.0.1:4200
as the API base URL instead of
127.0.0.1:4200/api
, so the Swagger paths looked inconsistent to me. Appreciate the clarification.
👍 1