ElsonOtake/api-documentation

It is an information-sharing project related to API documentation. The data from this repo supports the article created on Medium with API documentation tips

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Run tests
• 👥 Author
• 🔭 Future Features
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements
• 📝 License

📖 API Documentation

API documentation is an information-sharing project related to API documentation. The data from this application supports the article created on Medium with API documentation tips.

🛠 Built With

Tech Stack

Server

• Ruby on Rails
• RSpec Rails
• Rswag

Database

• SQLite

Key Features

• Basic API application
• CRUD
• Documentation using Rswagger

(back to top)

🚀 Live Demo

Add a link to your deployed project.

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

Ruby

Setup

Clone this repository to your desired folder:

using HTTPS:

  git clone https://github.com/ElsonOtake/api-documentation.git
  cd api-documentation

using an SSH key:

  git clone git@github.com:ElsonOtake/api-documentation.git
  cd api-documentation

using GitHub CLI:

  git clone gh repo clone ElsonOtake/api-documentation
  cd api-documentation

Install

Install this project with:

  bundle install

Create the database:

  rails db:create db:migrate

Usage

To run the project, execute the following command:

  rails server

Run tests

To generate the API documentation:

  rake rswag

(back to top)

👥 Author

👤 Elson Otake

• GitHub: elsonotake
• Twitter: @elsonotake
• LinkedIn: elsonotake

(back to top)

🔭 Future Features

• Login via API
• Authentication using token
• Protected endpoints

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

I would like to thank...

• Microverse

(back to top)

📝 License

This project is MIT licensed.

(back to top)