api
api copied to clipboard
readmeio
🚀 Automatic SDK generation from an OpenAPI definition
``` npx api@beta install @readme-nyc/v1.0#17681m2il63r8rns ```
The SDK and dynamic systems right now don't support Swagger 2.0 at all at the moment. I don't think it'll be too difficult to add support, we'll just need to...
```js const sdk = require('api')('@developers/v2.0#README_REGISTRY_UUID'); sdk.auth('MY_API_KEY'); (async () => { await sdk.get('/docs/MY_DOC_SLUG') .then(console.log) .catch(async err => { const res = await err.json() console.log(res) }) })() ``` The simple HTTP method...
https://github.com/readmeio/api/blob/main/packages/api/src/fetcher.ts#L49-L54 When you pass in a URL that 404s we just tell you that the URL was not found which isn't supper helpful if the URL you're supplying is doing...
This should resolve the issue brought up in https://github.com/readmeio/api/pull/447. Basically if an `Accept` header isn't defined in a paths `parameters` block we currently don't allow you to supply it in...
Occasionally an api call to a server will just hang indefinitely. I couldn't find in the documentation any way to supply a timeout in case the server hangs. Or am...
When working with an API, it's helpful to be able to mock out requests when unit testing client functionality. Since we've got the OpenAPI definition on hand for the API...
| 🚥 Resolves #536 | | :-- | This **completely** refactors how we're handling returning data to always return an object containing response data, response status, response headers, and the...
With the way `api` currently is if you want to access response status codes or headers you need to set `sdk.config({ parseResponse: false })` and then handle `res.json()` or `res.text()`...
| 🚥 Fix #448 | | :-- | ## 🧰 Changes * [x] Updates our parameter digestion and analysis to allow `Accept` headers to always be sent. * [x] Updates...