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.

Sign up for GitHub

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

Jump to bottom

Use Postman for API Documentation #296

Open

Nickyshe opened this issue Mar 7, 2024 · 1 comment

Labels

Nickyshe commented Mar 7, 2024 •

edited

Loading

Description

API Reference: I suggest using Postman for Sigstore API documentation instead of Swagger. The reasons are :

Postman provides a more intuitive interface for documenting APIs.
It also leverages testing and debugging your API
It also supports multiple markdown format
It also enhances collaboration among team
Postman also offers auto-generated documentation from requests using postbot
Postman Environment is developer focused

@dmitris @feelepxyz @flavio @phillmv

Nickyshe added the enhancement label

Nickyshe changed the title ~~Ehancement~~ Use Postman for API Documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment