Include JSON in API-related Dev Docs #39
zdmc23
started this conversation in
More Documentation
Replies: 1 comment 2 replies
-
@zdmc23 can you give an example of where you this would be used? |
Beta Was this translation helpful? Give feedback.
2 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Third-party Integrations with the D.T API send JSON in the body of the request, so let's display the JSON as a "JSON" or "JavaScript" tab in the code block (in addition to existing PHP): https://github.com/GitbookIO/plugin-codetabs
Examples where this would be helpful:
Integrations
For example,
Integromat
(no-code integration service similar to Zapier)However, when reviewing the D.T API Dev Docs, the developer is presented with a PHP version that they then need to map from PHP to JSON in their head. It would just ease the cognitive load if we presented a
Node.js
orJSON
orJavaScript
tab that showed the equivalent in JSON format.Testing
It would be helpful when performing any API tests via some HTTP client like
cURL
orPostman
.Google Cloud
Here is an example of how Google does this in their GCP API docs (and I have seen similar from Azure and other API providers):
Beta Was this translation helpful? Give feedback.
All reactions