entropic-dev / entropic-dev/boltzmann

OpenAPI export functionality

Open
#92 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
8
Forks
5
PR merge metrics
No merged PRs in 30d

Description

Use the information from routing, validation middleware, and possibly typescript return types[1] to generate Swagger YAML for ingestion into various tools.

The goal is to be able to feed Boltzmann-generated OpenAPI documents into various documentation generators & request tools (like Postman.) A stretch goal is that we can _lint_ these API docs.

[1]: We could also expose a `validate.returns({...jsonschema})` middleware that does response validation on the way out in dev mode for non-typescript projects? IDK exactly.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.