feat: automatically parse the api response based on content-type #240
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
mock-fs has limitations which means you can use console.log during test runs which is not ideal! Ended up doing something like this to get it to work: tschaub/mock-fs#234 (comment)
This allows us to remove the `.then(res => res.json())` line from our
code samples.
```
const sdk = require('api')('@readme/5f7ceacf43621b0311080a58');
sdk.getAPISpecification({perPage: '10', page: '1'})
.then(res => console.log(res))
.catch(err => console.error(err));
```
We only perform the parsing if it's a successful response. If there's an error
case then we return with the original response object so you can access
the status as well as the actual body.
The code and tests for this have been stolen verbatim from the explorer:
https://github.com/readmeio/api-explorer/blob/77b90ebed4673f168354cdcd730e34b7ee016360/packages/api-explorer/src/lib/parse-response.js#L13-L30
BREAKING CHANGE: this is a breaking change.
Taken from main codebase
erunion
reviewed
Feb 3, 2021
Since we dont know if the response is json or not, we can't make assumptions. In an ideal world we'd conditionally do this based on the accept header in the response, but Operation.getHeaders() only returns with an array of headers and not their actual values. I think this is good enough for now! #240 (comment)
erunion
approved these changes
Mar 24, 2021
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.
🧰 What's being changed?
This allows us to remove the
.then(res => res.json())line from ourcode samples.
We only perform the parsing if it's a successful response. If there's an error
case then we return with the original response object so you can access
the status as well as the actual body.
The code and tests for this have been stolen verbatim from the explorer:
https://github.com/readmeio/api-explorer/blob/77b90ebed4673f168354cdcd730e34b7ee016360/packages/api-explorer/src/lib/parse-response.js#L13-L30
BREAKING CHANGE: this is a breaking change.