cal.pub0.org/README.md

25 lines
773 B
Markdown
Raw Normal View History

2022-03-18 13:42:42 +00:00
# Cal.com Public API (Enterprise Only)
2022-03-23 21:22:57 +00:00
## This will be the new public enterprise-only API
2022-03-23 21:27:03 +00:00
This is the public REST api for cal.com.
2022-03-23 21:22:57 +00:00
## NextJS + TypeScript
It's a barebones **NextJS** + **TypeScript** project leveraging the nextJS API with a pages/api folder.
## No react
It doesn't have react or react-dom as a dependency, and will only be used by a redirect as a folder or subdomain on cal.com with maybe a v1 tag like:
- `v1.api.cal.com`
- `api.cal.com/v1`
- `app.cal.com/api/v1/`
## API Endpoint Validation
The API uses `zod` library like our main web repo. It validates that either GET query parameters or POST body content's are valid and up to our spec. It gives appropiate errors when parsing result's with schemas.
2022-03-23 21:27:03 +00:00
## Testing with Jest + node-mocks-http