RESTyped Axios
Axios typings for consuming RESTyped APIs
Usage
npm install restyped-axios
Note: >=2.0.0 supports TypeScript 2.8 and higher. Use a lower version if you need TypeScript 2.4-2.7 support.
It's just like normal axios, except you'll need to provide a RESTyped API definition file for the API you want to use.
// You'll get a compile error if you call an invalid route or use incorrect query params. Yay!client.request.then...
Special cases
/gifs/trending?api_key=...
)
GET with query params (e.g. Use the client.request({url: ..., params: ...})
syntax instead of client.get
in order to have your params typechecked. See above.
/posts/:id/like
)
Routes with params in their paths (e.g. Explicitly declare the canonical route in angle brackets to avoid an invalid route error.
client.post'/posts/3/like'
Popular APIs to try out
- Giphy API:
restyped-giphy-api