SWagger

[dorakadri]

how do i run swagger please a did dev:swagger but tell me no package found and can i just use the api and do my own ui ??

[dosubot[bot]]

Hi @dorakadri! I'm Dosu and I’m helping the cal.com team.

Swagger support is present in cal.com, but the dev:swagger command fails because the referenced package (@calcom/swagger) doesn't exist or isn't installed. Instead, Swagger docs are generated and served by the API server itself. When you run the API (v2), Swagger UI is available at the /docs endpoint unless you set the DOCS_URL environment variable to disable it. You can also generate Swagger docs manually by running the script at apps/api/v2/src/swagger/generate-swagger-script.ts see details.

If you want to build your own UI, you can use the API directly and reference the OpenAPI/Swagger JSON files in the repo, such as docs/api-reference/v2/openapi.json see details. The API is documented and actively maintained, so you have everything you need to create a custom UI.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}    

[Vibgitcode27]

@dorakadri When you clone the repo, you cannot just run dev:swagger to see the Swagger docs, it’s a full application setup, not a standalone Swagger server. But you can generete Swagger doc for the api servers.

Cal.com exposes two distinct API versions:

• V1 (legacy)
• V2 (current, written in Nest.js)

To explore the application's APIs:

1. Check out the API code under: apps/api
2. For V2, you can generate Swagger using the script at: apps/api/v2/src/swagger/generate-swagger-script.ts

You can absolutely build your own custom UI on top of the V2 APIs, since they are fully exposed and designed for external consumption.
For complete details on the V2 APIs, please refer to the official documentation: https://cal.com/docs/api-reference/v2/introduction