cloudflare / cloudflare/chanfana

Standalone openapi yaml schema generation

Open
#142 5 comments 1 reaction 0 assignees View on GitHub
Dominant language
TypeScript
Stars
766
Forks
70
Avg merge
25m
Merged PRs (30d)
4

Description

Is it possible to generate a openapi yaml schema file from the command line? Eg running a npm command? Without the server running.

Rationale:
In development workflow I would like to generate the yaml as it will be used as input for another npm task to generate a openapi client.
During (prod) build I would like to run both to make sure everything is correct.

Second question is whether it is possible to disable the docs endpoint and yaml/json when server is running.

Contributor guide

Open the contributing guide

Research direction

The issue names no files, tests, or entry points. First map how Chanfana currently builds and serves OpenAPI schemas, then define the CLI generation and optional endpoint behavior; done criteria should cover generation without a running server and disabling the docs and schema endpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, typescript
Domain
api, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.