https://github.com/moeki0/todos-api
https://github.com/moeki0/todos-api
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/moeki0/todos-api
- Owner: moeki0
- Created: 2025-04-08T00:30:05.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T00:30:50.000Z (about 1 year ago)
- Last Synced: 2025-07-31T13:37:11.281Z (11 months ago)
- Language: TypeScript
- Size: 4.88 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Todos API
This is a sample API which is protected by Auth0. It is used in the remote MCP demo to showcase the capabilities how the MCP server can be used to call a protected API on behalf of a user.
> Note: While for this demo we are deploying the API to Cloudflare, it could be deployed anywhere.
## Auth0 Configuration
In the Auth0 dashboard, create a new API in the APIs section.
Once the API is created, enable "Offline Access" so we can get a refresh token.
> Note: You can turn off the "Allow Skipping User Consent" if you want to force users to consent to the scopes.
And finally add the following API permissions:
- `read:todos`
- `read:billing`
That's it! You can now configure your local environment or deploy the API to Cloudflare.
## Development
Create a `.dev.vars` file in the root of the project with the following structure:
```
AUTH0_DOMAIN=yourtenant.us.auth0.com
AUTH0_AUDIENCE=urn:todos-api
```
The `AUTH0_DOMAIN` is the domain of the Auth0 tenant. The `AUTH0_AUDIENCE` is the audience of the API you created in the Auth0 tenant (eg: `urn:todos-api`).
### Testing the API
To test the API, you can use the following command:
```
npm run dev
```
This will start the worker and you can make requests to it. In the Auth0 dashboard there is a **Test** tab in the API where you can get an `access_token` to call the API. Use this to call the API as follows:
```bash
curl --request GET \
--url http://localhost:8788/api/me \
--header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6Im...'
```
If this call is successful, you should see the claims of the JWT token in the response.
## Deploying the API
To deploy the API to Cloudflare, you will first need to set the following secrets:
```bash
wrangler secret put AUTH0_DOMAIN
wrangler secret put AUTH0_AUDIENCE
```
Once the secrets are set, you can deploy the API with the following command:
```bash
npm run deploy
```