Repository files navigation

Type safety across REST APIs in TypeScript!

Rest.ts lets you write API contracts that tie together consumers and producers within the type system. Out of the box, Rest.ts gives you the following features:

• Auto-completion / intelliSense
• Easy code navigation

*It would be possible to generate swagger-style API docs from rest.ts definitions, but this feature has not been created yet. Contributors welcome!

If you are just getting started, read the five minutesquick start guide to get up to speed.

You will findall guides in the wiki.

If you are looking for advanced features, you might want to take a look at the API documentation for the module you are using:

• rest-ts-core
• rest-ts-express
• rest-ts-axios

Compatibility between rest.ts and runtypes:

This is an open source project maintained for free on a human being's spare time. It can only be as good as its user community is willing to make it.

• If you use this project, star it. It helps to get an idea of how many users there are.
• If something is not working, figure out why. If you can, share your findings in a new issue. If you can't, share your findings in a new issue.
• If something is missing, open an issue to spark the discussion.

You may also be interested inRESTyped, which fulfills the same role as Rest.ts, but with a different take on the problem.
SeeRest.ts vs RESTyped to chose which one best suits your requirements.