- 📖 About the Project
- 💻 Getting Started
- 👥 Author
- 🔭 Future Features
- 🤝 Contributing
- ⭐️ Show your support
- 🙏 Acknowledgements
- 📝 License
API documentation authentication is an information-sharing project related to API documentation. The data from this application supports the article created on Medium with API documentation tips.
Server
Database
- Authentication
Add a link to your deployed project.
To get a local copy up and running, follow these steps.
In order to run this project you need:
Clone this repository to your desired folder:
using HTTPS:
git clone https://github.com/ElsonOtake/api-documentation-authentication.git
cd api-documentation-authentication
using an SSH key:
https://github.com/ElsonOtake/api-documentation-authentication.git
cd api-documentation-authentication
using GitHub CLI:
git clone gh repo clone ElsonOtake/api-documentation-authentication
cd api-documentation-authentication
Install this project with:
bundle install
Create the database:
rails db:create db:migrate
To run the project, execute the following command:
rails server
To generate the API documentation:
rake rswag
👤 Elson Otake
- GitHub: elsonotake
- Twitter: @elsonotake
- LinkedIn: elsonotake
- Authentication using token documentation
- Documentation using protected endpoints
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
Give a ⭐️ if you like this project!
I would like to thank...
This project is MIT licensed.