https://github.com/adriangs1996/morty
A framework for creating API endpoints based on dry.rb fully compatible with rails
https://github.com/adriangs1996/morty
api dependency-injection dsl grape-api rails rails-api ruby
Last synced: 2 months ago
JSON representation
A framework for creating API endpoints based on dry.rb fully compatible with rails
- Host: GitHub
- URL: https://github.com/adriangs1996/morty
- Owner: adriangs1996
- License: mit
- Created: 2024-11-02T11:03:31.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-20T08:38:07.000Z (about 1 year ago)
- Last Synced: 2025-10-19T10:17:50.793Z (8 months ago)
- Topics: api, dependency-injection, dsl, grape-api, rails, rails-api, ruby
- Language: Ruby
- Homepage: https://adriangs1996.github.io/morty/
- Size: 2.88 MB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Mortymer
```markdown
███╗ ███╗ ██████╗ ██████╗ ████████╗██╗ ██╗███╗ ███╗███████╗██████╗
████╗ ████║██╔═══██╗██╔══██╗╚══██╔══╝╚██╗ ██╔╝████╗ ████║██╔════╝██╔══██╗
██╔████╔██║██║ ██║██████╔╝ ██║ ╚████╔╝ ██╔████╔██║█████╗ ██████╔╝
██║╚██╔╝██║██║ ██║██╔══██╗ ██║ ╚██╔╝ ██║╚██╔╝██║██╔══╝ ██╔══██╗
██║ ╚═╝ ██║╚██████╔╝██║ ██║ ██║ ██║ ██║ ╚═╝ ██║███████╗██║ ██║
```
Mortymer is a Ruby gem that simplifies API endpoint management and documentation for Ruby on Rails applications. It provides a clean DSL for defining API endpoints with input/output contracts and automatically generates OpenAPI documentation. It provides a really convenient way to handle
dependency Injection in Ruby, with an explicit approach but a really easy setup. No complex container initialization or registration (although
it is supported). Fully compatible with ruby constructors.
[](https://badge.fury.io/rb/morty)
[](https://opensource.org/licenses/MIT)
## !IMPORTANT
This gem is going under rapid development and as new features are added it might brake
compatibility from one version to another. I plan to give a stable release with version
0.1.0 and from there, follow semantic versioning.
## Features
- 🚀 Simple DSL for defining API endpoints
- 📝 Automatic OpenAPI documentation generation
- ✨ Input/Output contract validation
- 🎯 Dependency injection support
- 🛣️ Seamless Rails integration
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'mortymer'
```
And then execute:
```bash
bundle install
```
## Usage
### Basic Example
```ruby
class UserProfileEndpoint < ApplicationController
include Mortymer::ApiMetadata
# Define an endpoint with input/output contracts
get input: UserProfileInput, output: UserProfileOutput, path: '/api/v1/users/:id/profile'
def call(input)
user = User.find(input.id)
UserProfileOutput.new(
id: user.id,
name: user.name,
email: user.email
)
end
end
```
### Input/Output Contracts
```ruby
class UserProfileInput < Mortymer::Model
attribute :id, Types::Integer
attribute :include_details, Types::Bool.optional.default(false)
end
class UserProfileOutput < Mortymer::Model
attribute :id, Types::Integer
attribute :name, Types::String
attribute :email, Types::String
end
```
### Dependency Injection
```ruby
class UserService
include Mortymer::DependenciesDsl
# Inject dependencies
inject UserRepository
inject EmailService, as: :mailer
def process_user(id)
user = @user_repository.find_user(id)
@email_service.send_email(user.email, "Welcome!")
end
end
```
### Rails Integration
In your `config/routes.rb`:
```ruby
Rails.application.routes.draw do
Mortymer::Rails::Routes.new(self).mount_controllers
end
```
## OpenAPI Documentation
Mortymer automatically generates OpenAPI documentation for your API endpoints. The documentation includes:
- Endpoint paths and HTTP methods
- Request/response schemas
- Input validation rules
- Error responses
To generate the OpenAPI documentation:
```ruby
generator = Mortymer::OpenapiGenerator.new(
prefix: "/api",
title: "My API",
version: "v1"
)
generator.generate
```
## Contributing
We love your input! We want to make contributing to Mortymer as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
### Development Process
1. Fork the repo and create your branch from `master`
2. If you've added code, please, add some tests to contribute to gem health
3. If you've changed APIs, update the documentation accordingly
4. Ensure the test suite passes
5. Make sure your code lints
6. Issue that pull request!
### Running Tests
```bash
bundle install
bundle exec rspec
```
## License
MIT License. See [LICENSE](LICENSE) for details.
## Code of Conduct
This project follows the [Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/) Code of Conduct.
## Support
If you have any questions or need help with Mortymer:
- Open an [issue](https://github.com/yourusername/mortymer/issues)
- Join our [Discord community](#) (coming soon)
## Credits
Mortymer is maintained by [Adrian Gonzalez] and was inspired by the need for a simple,
yet powerful API management solution in the Ruby ecosystem, that integrates well
with existing frameworks. We deserve a FastAPI experience within the ruby side.