Merge pull request #49 from calcom/fix/update-readme-2
Agusti Fernandez
GitHub
commit
dfefa65ecb
154
README.md
154
README.md
|
|
@ -1,21 +1,106 @@
|
|||
# Cal.com Public API (Enterprise Only)
|
||||
|
||||
## This will be the new public enterprise-only API
|
||||
This is the public REST api for cal.com. It exposes CRUD Endpoints of all our most important resources. It makes it easy for anyone to integrate with cal at the programming level.
|
||||
|
||||
This is the public REST api for cal.com
|
||||
## Stack
|
||||
|
||||
## NextJS + TypeScript
|
||||
- NextJS
|
||||
- TypeScript
|
||||
- Prisma
|
||||
|
||||
It's a barebones **NextJS** + **TypeScript** project leveraging the nextJS API with a pages/api folder.
|
||||
## Development
|
||||
|
||||
- `api.cal.com/v1`
|
||||
- `api.cal.com/api/v1`
|
||||
### Setup
|
||||
|
||||
1. Clone the main repo (NOT THIS ONE)
|
||||
|
||||
```sh
|
||||
git clone --recurse-submodules -j8 https://github.com/calcom/cal.com.git
|
||||
```
|
||||
|
||||
1. Go to the project folder
|
||||
|
||||
```sh
|
||||
cd cal.com
|
||||
```
|
||||
|
||||
1. Copy `apps/api/.env.example` to `apps/api/.env`
|
||||
|
||||
```sh
|
||||
cp apps/api/.env.example apps/api/.env
|
||||
cp packages/prisma/.env.example packages/prisma/.env
|
||||
```
|
||||
|
||||
1. Install packages with yarn
|
||||
|
||||
```sh
|
||||
yarn
|
||||
```
|
||||
|
||||
1. Start developing
|
||||
|
||||
```sh
|
||||
yarn workspace @calcom/api dev
|
||||
```
|
||||
|
||||
1. Open [http://localhost:3002](http://localhost:3002) with your browser to see the result.
|
||||
|
||||
## API Authentication (API Keys)
|
||||
|
||||
The API requires a valid apiKey query param to be passed:
|
||||
You can generate them at <https://app.cal.com/settings/security>
|
||||
|
||||
For example:
|
||||
|
||||
```sh
|
||||
GET https://api.cal.com/v1/users?apiKey={INSERT_YOUR_CAL.COM_API_KEY_HERE}
|
||||
```
|
||||
|
||||
API Keys optionally may have expiry dates, if they are expired they won't work. If you create an apiKey without a userId relation, it won't work either for now as it relies on it to establish the current authenticated user.
|
||||
|
||||
In the future we might add support for header Beaer Auth if we need to or our customers require it.
|
||||
|
||||
## Next.config.js
|
||||
|
||||
### Redirects
|
||||
|
||||
Since this is an API only project, we don't want to have to type /api/ in all the routes, and so redirect all traffic to api, so a call to `api.cal.com/v1` will resolve to `api.cal.com/api/v1`
|
||||
|
||||
Likewise, v1 is added as param query called version to final /api call so we don't duplicate endpoints in the future for versioning if needed.
|
||||
|
||||
### Transpiling locally shared monorepo modules
|
||||
|
||||
We're calling several packages from monorepo, this need to be transpiled before building since are not available as regular npm packages. That's what withTM does.
|
||||
|
||||
```js
|
||||
"@calcom/app-store",
|
||||
"@calcom/prisma",
|
||||
"@calcom/lib",
|
||||
"@calcom/ee",
|
||||
```
|
||||
|
||||
## API Endpoint Validation
|
||||
|
||||
### Zod
|
||||
We validate that only the supported methods are accepted at each endpoint, so in
|
||||
|
||||
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.
|
||||
- **/endpoint**: you can only [GET] (all) and [POST] (create new)
|
||||
- **/endpoint/id**: you can read create and edit [GET, PATCH, DELETE]
|
||||
|
||||
### Zod Validations
|
||||
|
||||
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 errors when parsing result's with schemas and failing validation.
|
||||
|
||||
We use it in several ways, but mainly, we first import the auto-generated schema from @calcom/prisma for each model, which lives in `lib/validations/`
|
||||
|
||||
We have some shared validations which several resources require, like baseApiParams which parses apiKey in all requests, or querIdAsString or TransformParseInt which deal with the id's coming from req.query.
|
||||
|
||||
- **[*]BaseBodyParams** that omits any values from the model that are too sensitive or we don't want to pick when creating a new resource like id, userId, etc.. (those are gotten from context or elswhere)
|
||||
|
||||
- **[*]Public** that also omits any values that we don't want to expose when returning the model as a response, which we parse against before returning all resources.
|
||||
|
||||
- **[*]BodyParams** which merges both `[*]BaseBodyParams.merge([*]RequiredParams);`
|
||||
|
||||
- **withValid[*]** which is currently not being much used because is only useful in only post endpoints (we do post/get all in same file). This would validate the req.body of a POST call to API against our BaseBodyParams validation
|
||||
|
||||
### Next Validations
|
||||
|
||||
|
|
@ -27,11 +112,56 @@ We also use this useful helper library that let's us wrap our endpoints in a val
|
|||
|
||||
We aim to provide a fully tested API for our peace of mind, this is accomplished by using jest + node-mocks-http
|
||||
|
||||
## Next.config.js
|
||||
## Endpoints matrix
|
||||
|
||||
### Redirects
|
||||
| resource | get [id] | get all | create | edit | delete |
|
||||
|--------------------------|----------|----------|---------|-------|--------|
|
||||
| attendees | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| availabilities | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| booking-references | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| daily-event-references | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| destination-calendars | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| event-type-custom-inputs | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| event-types | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| memberships | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| payments | ✅ | ✅ | ❌ | ❌ | ❌ |
|
||||
| schedules | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| selected-calendars | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| teams | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| users | ✅ | 👤[1] | ✅ | ✅ | ✅ |
|
||||
|
||||
Since this will only support an API, we redirect the requests to root to the /api folder.
|
||||
We also added a redirect for future-proofing API versioning when we might need it, without having to resort to dirty hacks like a v1/v2 folders with lots of duplicated code, instead we redirect /api/v*/:rest to /api/:rest?version=*
|
||||
## Models from database that are not exposed
|
||||
|
||||
mostly because they're deemed too sensitive can be revisited if needed. most are expected to be used via cal's webapp.
|
||||
|
||||
- [ ] Api Keys
|
||||
- [ ] Credentials
|
||||
- [ ] Webhooks
|
||||
- [ ] ResetPasswordRequest
|
||||
- [ ] VerificationToken
|
||||
- [ ] ReminderMail
|
||||
|
||||
## Documentation (OpenAPI)
|
||||
|
||||
You will see that each endpoint has a comment at the top with the annotation `@swagger` with the documentation of the endpoint, **please update it if you change the code!** This is what auto-generates the OpenAPI spec by collecting the YAML in each endpoint and parsing it in /docs alongside the json-schema (auto-generated from prisma package, not added to code but manually for now, need to fix later)
|
||||
|
||||
### @calcom/apps/swagger
|
||||
|
||||
The documentation of the API lives inside the code, and it's auto-generated, the only endpoints that return without a valid apiKey are the homepage, with a JSON message redirecting you to the docs. and the /docs endpoint, which returns the OpenAPI 3.0 JSON Spec. Which SwaggerUi then consumes and generates the docs on.
|
||||
|
||||
## Deployment
|
||||
|
||||
`scripts/vercel-deploy.sh`
|
||||
The API is deployed to vercel.com, it uses a similar deployment script to website or webapp, and requires transpilation of several shared packages that are part of our turborepo ["app-store", "prisma", "lib", "ee"]
|
||||
in order to build and deploy properly.
|
||||
|
||||
## Envirorment variables
|
||||
|
||||
### Required
|
||||
|
||||
DATABASE_URL=DATABASE_URL="postgresql://postgres:@localhost:5450/calendso"
|
||||
|
||||
## Optional
|
||||
|
||||
API_KEY_PREFIX=cal_# This can be changed per envirorment so cal_test_ for staging for example.
|
||||
> If you're self-hosting under our commercial license, you can use any prefix you want for api keys. either leave the default cal_ (not providing any envirorment variable) or modify it
|
||||
|
|
|
|||
Loading…
Reference in New Issue