Skip to content

🌱 The Plant Friend API documentation 🌱 created with Swagger UI, hosted by GitHub Pages @ marcellharmaci.github.io/plantfriend-swagger-ui

License

Notifications You must be signed in to change notification settings

MarcellHarmaci/plantfriend-swagger-ui

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Plant Friend 🌱 documentation

The Plant Friend project's goal is to make you take really good care of your houseplants.

Have you ever forgotten the last time you watered a plant and ended up overwatering or underwatering the poor thing? With Plant Friend you can keep track of your watering schedule and the needs of your plants.

Swagger API documentation hosted with GitHub Pages

To read the API specification visit https://marcellharmaci.github.io/plantfriend-swagger-ui/.

Swagger UI (Supported by SMARTBEAR)

This repository is using Swagger UI to dynamically generate beautiful documentation for the Plant Friend project's API and host it for free with GitHub Pages.

The repository periodically auto-updates the Swagger UI dependency and creates a pull request. See the GitHub Actions workflow here.

Shoutout

Shoutout to @peter-evans for his tempate repository and blog post on how to host Swagger UI with GitHub Pages.

About

🌱 The Plant Friend API documentation 🌱 created with Swagger UI, hosted by GitHub Pages @ marcellharmaci.github.io/plantfriend-swagger-ui

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages