https://github.com/madeindjs/rest-api.ts

Free ebook to learn best practices to build an API using Node.js and Typescript.
https://github.com/madeindjs/rest-api.ts

json-api nodejs rest-api typescript

Last synced: 4 days ago
JSON representation

Free ebook to learn best practices to build an API using Node.js and Typescript.

• Host: GitHub
• URL: https://github.com/madeindjs/rest-api.ts
• Owner: madeindjs
• License: mit
• Created: 2020-11-21T06:13:02.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-19T16:04:34.000Z (over 3 years ago)
• Last Synced: 2024-11-02T13:42:07.700Z (11 days ago)
• Topics: json-api, nodejs, rest-api, typescript
• Language: TypeScript
• Homepage: https://leanpub.com/rest-api-ts/
• Size: 25.6 MB
• Stars: 18
• Watchers: 3
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        


  



Learn **best practices** to build an **API** using **Node.js** and **Typescript**. The intention of this book it’s not only to teach you how to build an API. The purpose is also to teach you how to build **scalable** and **maintainable** API which means **improve** your current Node.js knowledge. In this book you will learn to:

- Build JSON responses following [JSON:API standard](https://jsonapi.org/)

- Use Git for versioning

- Use Test Driven Development to add unit and functional tests

- Set up authentication with JSON Web Tokens (JWT)

- Optimize and cache the API

All the source code of this book is available in [Asciidoctor](https://asciidoctor.org/) format on this repository. So don’t hesitate to [fork the project](https://github.com/madeindjs/api_on_rails/fork) if you want to improve it or fix a mistake that I didn’t notice.

## Support the project

As you may know this project take me some times. So if you want to support me you can buy a version on Leanpub:

- [English version](https://leanpub.com/rest-api-ts/)

- French version _(in progress)_

Or you can support me with Liberapay: 

## Build book

```bash

$ git clone https://github.com/madeindjs/rest-api.ts

$ cd rest-api.ts

$ bundle install

$ rake "build:pdf[6,fr]"

```

You can see all build available with `rake -T`

```bash

$ rake -T

rake "build:all[version,lang]"   # Build all versions

rake "build:epub[version,lang]"  # Build an EPUB version

rake "build:html[version,lang]"  # Build an HTML version

rake "build:mobi[version,lang]"  # Build a MOBI version

rake "build:pdf[version,lang]"   # Build a PDF version

```

## License

This book is under [MIT license](https://opensource.org/licenses/MIT) and [Creative Common BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)