feat: Add Swagger API documentation
This commit introduces Swagger API documentation for all endpoints in the application. - Installs and . - Configures Swagger in to generate and serve API documentation at . - Adds JSDoc-style Swagger annotations to all routes in and the directory (, , , , , ). - Defines a cookie-based security scheme for authenticated routes. This allows for interactive API documentation and testing via the endpoint.
This commit is contained in:
151
routes/bible.js
151
routes/bible.js
@@ -13,11 +13,47 @@ const defaultBibleId = "592420522e16049f-01";
|
||||
|
||||
//getMedia('y42zyf3').then(console.log)
|
||||
DB.getDB.then((DB) => {
|
||||
/**
|
||||
* @swagger
|
||||
* tags:
|
||||
* name: Bible
|
||||
* description: Bible API
|
||||
*/
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible:
|
||||
* get:
|
||||
* summary: Get a list of available Bibles
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("", async (req, res) => {
|
||||
const bibles = await fetchAPI('bibles');
|
||||
return res.json(bibles);
|
||||
});
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible/books:
|
||||
* get:
|
||||
* summary: Get the books of a Bible
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: bibleId
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("/books", async (req, res) => {
|
||||
const bibleId = req.query.bibleId || defaultBibleId;
|
||||
const bibles = await fetchAPI('bibles/' + bibleId +"/books");
|
||||
@@ -30,12 +66,56 @@ DB.getDB.then((DB) => {
|
||||
return res.json(bibles);
|
||||
});
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible/books/{bookId}:
|
||||
* get:
|
||||
* summary: Get details for a specific book
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: bookId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: bibleId
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("/books/:bookId", async (req, res) => {
|
||||
const bookId = req.params.bookId;
|
||||
const bibles = await fetchAPI('bibles/' + bibleId +"/books/" + bookId);
|
||||
return res.json(bibles);
|
||||
});
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible/books/{bookId}/chapters:
|
||||
* get:
|
||||
* summary: Get the chapters of a book
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: bookId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: bibleId
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("/books/:bookId/chapters", async (req, res) => {
|
||||
const bookId = req.params.bookId;
|
||||
const bibleId = req.query.bibleId || defaultBibleId;
|
||||
@@ -43,6 +123,28 @@ DB.getDB.then((DB) => {
|
||||
return res.json(bibles);
|
||||
});
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible/chapters/{chapterId}:
|
||||
* get:
|
||||
* summary: Get the content of a chapter
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: chapterId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: bibleId
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("/chapters/:chapterId", async (req, res) => {
|
||||
const chapterId = req.params.chapterId;
|
||||
const bibleId = req.query.bibleId || defaultBibleId;
|
||||
@@ -50,6 +152,28 @@ DB.getDB.then((DB) => {
|
||||
return res.json(bibles);
|
||||
});
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible/chapters/{chapterId}/verses:
|
||||
* get:
|
||||
* summary: Get the verses of a chapter
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: path
|
||||
* name: chapterId
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: bibleId
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("/chapters/:chapterId/verses", async (req, res) => {
|
||||
const chapterId = req.params.chapterId;
|
||||
const bibleId = req.query.bibleId || defaultBibleId;
|
||||
@@ -57,6 +181,33 @@ DB.getDB.then((DB) => {
|
||||
return res.json(bibles);
|
||||
});
|
||||
|
||||
/**
|
||||
* @swagger
|
||||
* /bible/search:
|
||||
* get:
|
||||
* summary: Search the Bible
|
||||
* tags: [Bible]
|
||||
* security:
|
||||
* - cookieAuth: []
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: query
|
||||
* required: true
|
||||
* schema:
|
||||
* type: string
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* default: 10
|
||||
* - in: query
|
||||
* name: bibleId
|
||||
* schema:
|
||||
* type: string
|
||||
* responses:
|
||||
* 200:
|
||||
* description: OK
|
||||
*/
|
||||
router.get("/search", async (req, res) => {
|
||||
const query = req.query.query;
|
||||
const limit = req.query.limit || 10;
|
||||
|
||||
Reference in New Issue
Block a user