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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add API Playground #716

Merged
merged 23 commits into from
Jul 23, 2024
Merged

Add API Playground #716

merged 23 commits into from
Jul 23, 2024

Conversation

ryanwaits
Copy link
Collaborator

@ryanwaits ryanwaits commented Jul 20, 2024

What does this PR do?

This PR adds the ability to make an API call directly from the API reference pages through the browser. There were also a few new endpoints that have been added.

For certain endpoints, like the Call read-only function, some additional examples have been added on how to convert arguments to their hexadecimal representations and generate a JSON body for the request. That way developers can use the API Playground for more complex queries.

The following API reference pages have an API Playground:

  • Stacks Blockchain API
  • Token Metadata API
  • Ordinals API
  • Runes API
Screenshot 2024-07-20 at 7 01 07 PM

Chores

  • Remove BTC Faucet endpoint

@ryanwaits ryanwaits self-assigned this Jul 20, 2024
Copy link

vercel bot commented Jul 20, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
hiro-systems-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 23, 2024 3:24pm

@ryanwaits ryanwaits marked this pull request as ready for review July 20, 2024 23:50
@ryanwaits ryanwaits marked this pull request as draft July 20, 2024 23:53
@ryanwaits ryanwaits changed the title api playground Add API Playground Jul 22, 2024
Copy link
Contributor

@ECBSJ ECBSJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome

Copy link
Contributor

@ECBSJ ECBSJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good

@ryanwaits ryanwaits merged commit 07a5ea7 into main Jul 23, 2024
2 checks passed
@ryanwaits ryanwaits deleted the feat/api-playground branch July 23, 2024 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants