Skip to content

Add openapi template #713

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 24, 2025
Merged

Add openapi template #713

merged 6 commits into from
Jun 24, 2025

Conversation

G4brym
Copy link
Contributor

@G4brym G4brym commented Jun 19, 2025

Description

This pr adds an openapi template

Checklist

  • Template Metadata
    • template directory ends with -template
    • "cloudflare" section of package.json is populated
    • template preview image uploaded to Images
    • README is populated and uses <!-- dash-content-start --> and <!-- dash-content-end --> to designate the Dash readme preview
    • package.json contains a deploy command

Please upload the following image for the pr
localhost_8787_
eview:

Copy link
Contributor

template name version latestVersion isDevDependency
openapi-template chanfana ^2.8.1 2.8.1 false
openapi-template hono ^4.8.0 4.8.0 false
openapi-template zod ^3.25.67 3.25.67 false

Copy link
Contributor

Preview link not generated: you must be on a branch, not on a fork.
Collaborators may enable previews for this pull request by attaching the allow preview label.
If you are already a collaborator, please create a branch rather than forking.

@G4brym
Copy link
Contributor Author

G4brym commented Jun 19, 2025

Build is failing due to the live demo url not working, as i cannot deploy this worker on templates account

@deloreyj deloreyj added the allow preview allows for preview links on forks label Jun 23, 2025
Copy link
Contributor

template name version latestVersion isDevDependency
openapi-template chanfana ^2.8.1 2.8.1 false
openapi-template hono ^4.8.0 4.8.2 false
openapi-template zod ^3.25.67 3.25.67 false
openapi-template wrangler 4.20.3 4.20.5 true

@G4brym G4brym force-pushed the add-openapi-template branch from f16f889 to a9d5663 Compare June 23, 2025 21:07
Copy link
Contributor

template name version latestVersion isDevDependency
openapi-template chanfana ^2.8.1 2.8.1 false
openapi-template hono ^4.8.0 4.8.2 false
openapi-template zod ^3.25.67 3.25.67 false
openapi-template wrangler 4.20.3 4.21.0 true

Copy link
Contributor

@deloreyj deloreyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this template a lot. What would you think about adding a few tests to this? I think it'd be pretty straightforward to add vitest-pool-workers and show how to hit the hono endpoints with app.request and it would make this a very complete API starter.

@G4brym
Copy link
Contributor Author

G4brym commented Jun 24, 2025

Hey @deloreyj ive just added unit tests to the template

Copy link
Contributor

template name version latestVersion isDevDependency
openapi-template chanfana ^2.8.1 2.8.1 false
openapi-template hono ^4.8.0 4.8.2 false
openapi-template zod ^3.25.67 3.25.67 false
openapi-template @cloudflare/vitest-pool-workers ^0.8.44 0.8.44 true
openapi-template @types/node 22.15.19 24.0.3 true
openapi-template wrangler 4.20.3 4.21.0 true

Copy link
Contributor

Dashboard preview link

@G4brym G4brym force-pushed the add-openapi-template branch from 993f4db to d97f67a Compare June 24, 2025 16:37
Copy link
Contributor

template name version latestVersion isDevDependency
openapi-template chanfana ^2.8.1 2.8.1 false
openapi-template hono ^4.8.0 4.8.2 false
openapi-template zod ^3.25.67 3.25.67 false
openapi-template @cloudflare/vitest-pool-workers ^0.8.44 0.8.44 true
openapi-template @types/node 22.15.19 24.0.4 true
openapi-template wrangler 4.20.3 4.21.0 true

Copy link
Contributor

Dashboard preview link

Copy link
Contributor

template name version latestVersion isDevDependency
chanfana-openapi-template chanfana ^2.8.1 2.8.1 false
chanfana-openapi-template hono ^4.8.0 4.8.2 false
chanfana-openapi-template zod ^3.25.67 3.25.67 false
chanfana-openapi-template @cloudflare/vitest-pool-workers ^0.8.44 0.8.45 true
chanfana-openapi-template @types/node 22.15.19 24.0.4 true
chanfana-openapi-template wrangler 4.20.3 4.21.1 true

Copy link
Contributor

Dashboard preview link

@deloreyj deloreyj merged commit 4d2fb75 into cloudflare:main Jun 24, 2025
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
allow preview allows for preview links on forks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants