https://github.com/2kabhishek/swaggerize
Swaggerize Your APIs 🎇📃
https://github.com/2kabhishek/swaggerize
api demo openapi rails rspec swagger
Last synced: 3 months ago
JSON representation
Swaggerize Your APIs 🎇📃
- Host: GitHub
- URL: https://github.com/2kabhishek/swaggerize
- Owner: 2KAbhishek
- License: gpl-3.0
- Created: 2023-02-27T08:10:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-08-26T21:28:20.000Z (almost 2 years ago)
- Last Synced: 2025-01-12T03:27:52.166Z (5 months ago)
- Topics: api, demo, openapi, rails, rspec, swagger
- Language: Ruby
- Size: 143 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
swaggerize is a rails API application to demonstrate swagger integration with rails using rswag gem.
## ✨ Features
- Rails API app with interactive API docs
- Seeds with FactoryBot
## Setup
### ⚡ Requirements
- ruby 3.1.2
### 🚀 Installation
```bash
git clone https://github.com/2kabhishek/swaggerize
cd swaggerize
bundle install
bin/rake db:reset
```
### 💻 Usage
```bash
bin/rails s
```
## Behind The Code
### 🌈 Inspiration
Was learning about swagger and wanted to try integration with rails
### 💡 Challenges/Learnings
- The main challenges were setting up `rswag`
- I learned about OpenAPI specs, swagger and the tooling around swagger.
### 🧰 Tooling
- [rswag](https://github.com/rswag/rswag) — Gem for Swagger integration
- [Dotfiles](https://github.com/2kabhishek/Dotfiles) — Dev Environment
- [nvim2k](https://github.com/2kabhishek/nvim2k) — Personalized Editor
- [awesome2k](https://github.com/2kabhishek/awesome2k) — Tiling Window Manager
⭐ hit the star button if you found this useful ⭐
Source
| Blog
| Twitter
| LinkedIn
| More Links
| Other Projects
