Add api documentation

Author: Cyrus-Kiprop

Gemfile

@@ -56,6 +56,7 @@ group :development do
  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
  gem 'spring'
  gem 'spring-watcher-listen', '~> 2.0.0'
+ gem 'rspec_api_documentation'
 end
 
 # Windows does not include zoneinfo files, so bundle the tzinfo-data gem

Gemfile.lock

@@ -104,6 +104,7 @@ GEM
  mini_portile2 (2.4.0)
  minitest (5.14.2)
  msgpack (1.3.3)
+ mustache (1.1.1)
  nio4r (2.5.2)
  nokogiri (1.10.10)
  mini_portile2 (~> 2.4.0)
@@ -149,6 +150,10 @@ GEM
  ffi (~> 1.0)
  regexp_parser (1.7.1)
  rexml (3.2.4)
+ rspec (3.9.0)
+ rspec-core (~> 3.9.0)
+ rspec-expectations (~> 3.9.0)
+ rspec-mocks (~> 3.9.0)
  rspec-core (3.9.2)
  rspec-support (~> 3.9.3)
  rspec-expectations (3.9.2)
@@ -166,6 +171,10 @@ GEM
  rspec-mocks (~> 3.9)
  rspec-support (~> 3.9)
  rspec-support (3.9.3)
+ rspec_api_documentation (6.1.0)
+ activesupport (>= 3.0.0)
+ mustache (~> 1.0, >= 0.99.4)
+ rspec (~> 3.0)
  rubocop (0.90.0)
  parallel (~> 1.10)
  parser (>= 2.7.1.1)
@@ -219,6 +228,7 @@ DEPENDENCIES
  puma (~> 4.1)
  rails (~> 6.0.3, >= 6.0.3.2)
  rspec-rails
+ rspec_api_documentation
  rubocop
  shoulda-matchers
  spring

README.md

@@ -11,7 +11,7 @@
  <h3 align="center">Health App API</h3>
 
  <p align="center">
- A web App created in the fulfillment of Microverse mandatory Ruby on Rails capstone project.
+ A simple health api app.
  <br />
  <a href="https://github.com/Cyrus-Kiprop/rails-react-health-app/issues">Report Bug</a>
  ·
@@ -45,7 +45,7 @@ A progressive Health Tracking mobile web app. User can utilize the apps' exposed
 
 ## Api Documentation
 
-Click [ here ](https://afritrend.herokuapp.com/users/sign_in) for a live demo of the app.
+Click [ here ](https://web.postman.co/collections/8007314-882ee6da-afb0-49db-9eaa-4e9c94059972?version=latest&workspace=ab4298f5-d0f8-4bf1-8dc4-baa6db7fbe13) for api documentation.
 
 ### Built With
 
@@ -76,7 +76,7 @@ To get a local copy up and running follow these simple example steps.
 
 - Ruby -v 2.7.1 -[click here](https://www.ruby-lang.org/en/)
 
-- Rails -v 5.2.4
+- Rails -v 5.2.4+
 
 ```sh
 gem install rails -v 5.2.4
@@ -216,4 +216,3 @@ Distributed under the MIT License. See [ LICENSE ](https://github.com/Cyrus-Kipr
 [stars-url]: https://github.com/Cyrus-Kiprop/rails-react-health-app/stargazers
 [issues-shield]: https://img.shields.io/github/issues/Cyrus-Kiprop/rails-react-health-app.svg?style=flat-square
 [issues-url]: https://github.com/Cyrus-Kiprop/rails-react-health-app/issues
-[product-screenshot]: /app/assets/images/screenshot.png