jsonapi-resources
所属分类:collect
开发工具:Ruby
文件大小:0KB
下载次数:0
上传日期:2023-06-19 16:09:03
上 传 者:
sh-1993
说明: 一个以资源为中心的Rails库,用于开发JSON:API兼容服务器。,
(A resource-focused Rails library for developing JSON:API compliant servers.,)
文件列表:
Gemfile (532, 2023-09-19)
LICENSE.txt (1082, 2023-09-19)
Rakefile (962, 2023-09-19)
jsonapi-resources.gemspec (1552, 2023-09-19)
lib/ (0, 2023-09-19)
lib/bug_report_templates/ (0, 2023-09-19)
lib/bug_report_templates/rails_5_latest.rb (3024, 2023-09-19)
lib/bug_report_templates/rails_5_master.rb (3511, 2023-09-19)
lib/generators/ (0, 2023-09-19)
lib/generators/jsonapi/ (0, 2023-09-19)
lib/generators/jsonapi/USAGE (274, 2023-09-19)
lib/generators/jsonapi/controller_generator.rb (365, 2023-09-19)
lib/generators/jsonapi/resource_generator.rb (359, 2023-09-19)
lib/generators/jsonapi/templates/ (0, 2023-09-19)
lib/generators/jsonapi/templates/jsonapi_controller.rb (118, 2023-09-19)
lib/generators/jsonapi/templates/jsonapi_resource.rb (108, 2023-09-19)
lib/jsonapi-resources.rb (1439, 2023-09-19)
lib/jsonapi/ (0, 2023-09-19)
lib/jsonapi/active_relation/ (0, 2023-09-19)
lib/jsonapi/active_relation/adapters/ (0, 2023-09-19)
lib/jsonapi/active_relation/adapters/join_left_active_record_adapter.rb (1031, 2023-09-19)
lib/jsonapi/active_relation/join_manager.rb (11815, 2023-09-19)
lib/jsonapi/active_relation_resource.rb (37754, 2023-09-19)
lib/jsonapi/acts_as_resource_controller.rb (9546, 2023-09-19)
lib/jsonapi/basic_resource.rb (35558, 2023-09-19)
lib/jsonapi/cached_response_fragment.rb (3607, 2023-09-19)
lib/jsonapi/callbacks.rb (1426, 2023-09-19)
lib/jsonapi/compiled_json.rb (807, 2023-09-19)
lib/jsonapi/configuration.rb (11483, 2023-09-19)
lib/jsonapi/error.rb (2592, 2023-09-19)
lib/jsonapi/error_codes.rb (2216, 2023-09-19)
lib/jsonapi/exceptions.rb (25659, 2023-09-19)
lib/jsonapi/formatter.rb (3189, 2023-09-19)
... ...
# JSONAPI::Resources [![Gem Version](https://badge.fury.io/rb/jsonapi-resources.svg)](https://badge.fury.io/rb/jsonapi-resources) [![Build Status](https://secure.travis-ci.org/cerebris/jsonapi-resources.svg?branch=master)](http://travis-ci.org/cerebris/jsonapi-resources) [![Code Climate](https://codeclimate.com/github/cerebris/jsonapi-resources/badges/gpa.svg)](https://codeclimate.com/github/cerebris/jsonapi-resources)
[![Join the chat at https://gitter.im/cerebris/jsonapi-resources](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/cerebris/jsonapi-resources?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
`JSONAPI::Resources`, or "JR", provides a framework for developing an API server that complies with the
[JSON:API](http://jsonapi.org/) specification.
Like JSON:API itself, JR's design is focused on the resources served by an API. JR needs little more than a definition
of your resources, including their attributes and relationships, to make your server compliant with JSON API.
JR is designed to work with Rails 5.1+, and provides custom routes, controllers, and serializers. JR's resources may be
backed by ActiveRecord models or by custom objects.
## Documentation
Full documentation can be found at [http://jsonapi-resources.com](http://jsonapi-resources.com), including the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/) specific to this version.
## Demo App
We have a simple demo app, called [Peeps](https://github.com/cerebris/peeps), available to show how JR is used.
## Client Libraries
JSON:API maintains a (non-verified) listing of [client libraries](http://jsonapi.org/implementations/#client-libraries)
which *should* be compatible with JSON:API compliant server implementations such as JR.
## Installation
Add JR to your application's `Gemfile`:
```
gem 'jsonapi-resources'
```
And then execute:
```bash
bundle
```
Or install it yourself as:
```bash
gem install jsonapi-resources
```
**For further usage see the [v0.10 alpha Guide](http://jsonapi-resources.com/v0.10/guide/)**
## Contributing
1. Submit an issue describing any new features you wish it add or the bug you intend to fix
1. Fork it ( http://github.com/cerebris/jsonapi-resources/fork )
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Run the full test suite (`rake test`)
1. Fix any failing tests
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Create a new Pull Request
## Did you find a bug?
* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/cerebris/jsonapi-resources/issues).
* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/cerebris/jsonapi-resources/issues/new).
Be sure to include a **title and clear description**, as much relevant information as possible,
and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
* If possible, use the relevant bug report templates to create the issue.
Simply copy the content of the appropriate template into a .rb file, make the necessary changes to demonstrate the issue,
and **paste the content into the issue description or attach as a file**:
* [**Rails 5** issues](https://github.com/cerebris/jsonapi-resources/blob/master/lib/bug_report_templates/rails_5_master.rb)
## License
Copyright 2014-2021 Cerebris Corporation. MIT License (see LICENSE for details).
近期下载者:
相关文件:
收藏者: