/mttu-api

this is a project work

Primary LanguageRuby

Todo API

Maintainability Test Coverage Build Status

Simple RESTful JSON API with documentation. Implemented with Rails 5.2

Features

  1. uses basic authentication,
  2. Thin controllers with Rails exception handler
  3. Read-only Active Record mode for completed tasks
  4. Task prioritization
  5. Image upload for comment via Active Storage, comment img-src attribute
  6. Smart API versionization with default version, accepts version in headers
  7. Serialized API output
  8. API documentation, accepts version in headers
  9. Minimal gem set

For rebuild current api doc just use:

rails api:v1:docs

Technology summary

  • Ruby 2.6.5
  • Rails 5.2.1, bcrypt, jwt, active storage, acts_as_list
  • Testing: RSpec 3.8, rspec-rails 3.8.1, simplecov 0.16.1, RspecFileChef 0.1.2, factory_bot_rails, shoulda-matchers, faker, database_cleaner

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/bestwebua/todo-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The application is available as open source under the terms of the MIT License.