-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore-[167190525]: setup api documentation
- install swagger-ui-express package to serve api docs to static url - install yamljs package to load api docs yaml file - write api documentation for the request to get the app root url [Finishes #167190525]
- Loading branch information
1 parent
93de2a7
commit c4ce7ab
Showing
4 changed files
with
87 additions
and
26 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
openapi: 3.0.1 | ||
|
||
info: | ||
title: Authors Haven API Documentation | ||
description: Create a community of like minded authors to foster inspiration and innovation by leveraging the modern web. | ||
version: 1.0.0 | ||
contact: | ||
email: teamrambo50@gmail.com | ||
|
||
license: | ||
name: Apache 2.0 | ||
url: http://www.apache.org/licenses/LICENSE-2.0.html | ||
|
||
servers: | ||
- url: / | ||
desription: Localhost server | ||
- url: https://authors-haven-development.herokuapp.com/ | ||
desription: Heroku development server | ||
|
||
paths: | ||
/: | ||
summary: Represent root of the application | ||
description: Represent root of the application. | ||
get: | ||
summary: Returns a welcome message. | ||
description: Returns a welcome message. | ||
responses: | ||
'200': | ||
description: Success | ||
content: | ||
text/plain: | ||
schema: | ||
type: string | ||
example: Welcome to Authors Haven | ||
|
||
components: | ||
securitySchemes: | ||
BearerAuth: | ||
type: http | ||
scheme: bearer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters