{"id":13878910,"url":"https://github.com/madeindjs/api_on_rails","last_synced_at":"2025-04-04T16:17:24.478Z","repository":{"id":33996526,"uuid":"157202993","full_name":"madeindjs/api_on_rails","owner":"madeindjs","description":"Learn best practices to build an API using Ruby on Rails 5/6","archived":false,"fork":false,"pushed_at":"2024-07-02T19:46:27.000Z","size":10661,"stargazers_count":372,"open_issues_count":7,"forks_count":118,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-28T15:11:18.201Z","etag":null,"topics":["api","api-rest","asciidoctor","best-practices","book","jwt-authentication","rails","ruby"],"latest_commit_sha":null,"homepage":"https://leanpub.com/apionrails6","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/madeindjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":"alexandre_rousseau","issuehunt":null,"otechie":null,"custom":null}},"created_at":"2018-11-12T11:26:25.000Z","updated_at":"2025-03-04T21:40:25.000Z","dependencies_parsed_at":"2023-12-13T08:54:15.940Z","dependency_job_id":"4f3c162a-2527-404e-bd26-60ada281d0b4","html_url":"https://github.com/madeindjs/api_on_rails","commit_stats":null,"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madeindjs%2Fapi_on_rails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madeindjs%2Fapi_on_rails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madeindjs%2Fapi_on_rails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/madeindjs%2Fapi_on_rails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/madeindjs","download_url":"https://codeload.github.com/madeindjs/api_on_rails/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247208190,"owners_count":20901570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-rest","asciidoctor","best-practices","book","jwt-authentication","rails","ruby"],"created_at":"2024-08-06T08:02:03.985Z","updated_at":"2025-04-04T16:17:24.460Z","avatar_url":"https://github.com/madeindjs.png","language":"Ruby","funding_links":["https://liberapay.com/alexandre_rousseau","https://liberapay.com/alexandre_rousseau/donate"],"categories":["Ruby"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003e\n  \u003cimg src=\"rails6/fr/img/logo.svg\" alt=\"Api on Rails 6\" /\u003e\n\u003c/h1\u003e\n\n![List of sponsors](https://the-godfather.tech/api/v1/badge?repository=https%3A%2F%2Fgithub.com%2Fmadeindjs%2Fapi_on_rails\u0026style=flat\u0026version=1\u0026maxAge=60)\n\nLearn **best practices** to build an **API** using **Ruby on Rails** 5/6. The intention with this book it's not only to teach you how to build an API with Rails. The purpose is also to teach you how to build **scalable** and **maintainable** API with Rails which means **improve** your current Rails knowledge. In this book you will learn to:\n\n- Build JSON responses\n- Use Git for version controlling\n- Testing your endpoints\n- Optimize and cache the API\n\nThis book is based on [\"APIs on Rails: Building REST APIs with Rails\"](http://apionrails.icalialabs.com/book/). It was initially published in 2014 by [Abraham Kuri](https://twitter.com/kurenn). Since the original work was not maintained, I wanted to update this excellent work. 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.\n\nUpdate \u0026 translation of the [API on Rails (EN)](http://apionrails.icalialabs.com/book) book. This book is written using [Asciidoctor](https://asciidoctor.org).\n\n## Support the project\n\nAs you may know this project take me some times. So if you want to support me you can buy a version on Leanpub:\n\n- Rails 5\n  - [English version](https://leanpub.com/apionrails5/)\n  - [French version](https://leanpub.com/apionrails5-fr)\n- Rails 6\n  - [English version](https://leanpub.com/apionrails6/)\n  - [French version](https://leanpub.com/apionrails6-fr)\n  - [Spanish version](https://leanpub.com/apionrails6-es) (thanks to [Oscar Téllez](https://github.com/oscartzgz))\n\nOr you can support me with Liberapay: \u003cnoscript\u003e\u003ca href=\"https://liberapay.com/alexandre_rousseau/donate\"\u003e\u003cimg alt=\"Donate using Liberapay\" src=\"https://liberapay.com/assets/widgets/donate.svg\"\u003e\u003c/a\u003e\u003c/noscript\u003e\n\n## Build book\n\n```bash\n$ git clone https://github.com/madeindjs/api_on_rails/\n$ cd api_on_rails\n$ bundle install\n$ rake \"build:pdf[6,fr]\"\n```\n\nYou can see all build available with `rake -T`\n\n```bash\n$ rake -T\nrake \"build:all[version,lang]\"   # Build all versions\nrake \"build:epub[version,lang]\"  # Build an EPUB version\nrake \"build:html[version,lang]\"  # Build an HTML version\nrake \"build:mobi[version,lang]\"  # Build a MOBI version\nrake \"build:pdf[version,lang]\"   # Build a PDF version\n```\n\n## License\n\nThis 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/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadeindjs%2Fapi_on_rails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmadeindjs%2Fapi_on_rails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmadeindjs%2Fapi_on_rails/lists"}