Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃殌 Feature: Plugin Api-Docs Request Samples #24733

Open
2 tasks done
BryanJaramilloAE opened this issue May 13, 2024 · 1 comment
Open
2 tasks done

馃殌 Feature: Plugin Api-Docs Request Samples #24733

BryanJaramilloAE opened this issue May 13, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@BryanJaramilloAE
Copy link

馃敄 Feature description

Hi, I've been using the api-doc plugin these days and I thought it would be great if it would show examples of endpoint requests, for example in curl, Nodejs or Python.

Something like this:

curl --request POST \
  --url https://petstore.swagger.io/v2/pet/petId/uploadImage \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: multipart/form-data' \
  --form additionalMetadata= \
  --form file=

馃帳 Context

This would be really usefull for users to quickly test the endpoind.

This is an exaple from Spotlight: https://elements-demo.stoplight.io/?spec=https%3A%2F%2Fpetstore.swagger.io%2Fv2%2Fswagger.json#/operations/uploadFile

鉁岋笍 Possible Implementation

No response

馃憖 Have you spent some time to check if this feature request has been raised before?

  • I checked and didn't find similar issue

馃彚 Have you read the Code of Conduct?

Are you willing to submit PR?

None

@BryanJaramilloAE BryanJaramilloAE added the enhancement New feature or request label May 13, 2024
@vinzscam
Copy link
Member

thanks for the suggestion. Yes, it would be a nice addition

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants