LukeMathWalker / LukeMathWalker/pavex

Automatic openapi generation

Open
#195 2 comments 12 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement planned
Dominant language
Rust
Stars
2.1k
Forks
80
PR merge metrics
No merged PRs in 30d

Description

As pavex is a compiler, it would be cool to explore the possibilities of generating openapi specs for the blueprint.

I understand that this might not be that high on the list of features at the moment, but I think it is one of the biggest pain points when creating APIs, and I would love to see pavex's take on it.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue proposes generating OpenAPI specifications from a Pavex blueprint, but it names no files, entry points, or tests to inspect. Clarify which blueprint information and API surfaces must be represented, then define the expected generated output and validation approach before implementation.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, rust
Domain
api, backend-api-design
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.