Update reference.mdx #1631
Closed
Update reference.mdx #1631
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# ngrok API Reference We love API reference documentation and we know you do too. As a developer, it's often the first place to go to understand a system's domain model and to understand all of its capabilities. ## Correctness As developers ourselves, we crave confidence in the correctness of our documentation. To that end, ngrok's API reference documentation is generated from the same specifications that are used to generate our server-side API stubs so that you can be confident that the documented parameters match the implementation. ## Example Correctness Example requests and responses you see in the API documentation are generated from a set of integration tests that run against the API so that you can be confident that the examples in the reference documentation match the behavior of the API itself.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ngrok API Reference
We love API reference documentation and we know you do too. As a developer, it's often the first place to go to understand a system's domain model and to understand all of its capabilities.
Correctness
As developers ourselves, we crave confidence in the correctness of our documentation. To that end, ngrok's API reference documentation is generated from the same specifications that are used to generate our server-side API stubs so that you can be confident that the documented parameters match the implementation.
Example Correctness
Example requests and responses you see in the API documentation are generated from a set of integration tests that run against the API so that you can be confident that the examples in the reference documentation match the behavior of the API itself.