https://github.com/codebam/cloudflare-ai-api
https://github.com/codebam/cloudflare-ai-api
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/codebam/cloudflare-ai-api
- Owner: codebam
- Created: 2023-10-10T22:44:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-03T21:42:35.000Z (over 2 years ago)
- Last Synced: 2025-01-15T13:58:23.321Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://cloudflare-ai-api.codebam.workers.dev
- Size: 76.2 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cloudflare Workers OpenAPI 3.1
This is a Cloudflare Worker with OpenAPI 3.1 using [itty-router-openapi](https://github.com/cloudflare/itty-router-openapi).
This is an example project made to be used as a quick start into building OpenAPI compliant Workers that generates the
`openapi.json` schema automatically from code and validates the incoming request to the defined parameters or request body.
## Get started
1. Sign up for [Cloudflare Workers](https://workers.dev). The free tier is more than enough for most use cases.
2. Clone this project and install dependencies with `npm install`
3. Run `wrangler login` to login to your Cloudflare account in wrangler
4. Run `wrangler deploy` to publish the API to Cloudflare Workers
## Project structure
1. Your main router is defined in `src/index.ts`.
2. Each endpoint has its own file in `src/endpoints/`.
3. For more information read the [itty-router-openapi official documentation](https://cloudflare.github.io/itty-router-openapi/).
## Development
1. Run `wrangler dev` to start a local instance of the API.
2. Open `http://localhost:9000/` in your browser to see the Swagger interface where you can try the endpoints.
3. Changes made in the `src/` folder will automatically trigger the server to reload, you only need to refresh the Swagger interface.