Swagger로 Express AP를 문서화하기

app.use( "/api-docs", swaggerUi.serve, swaggerUi.setup(specs, { explorer: true }) );

/** * @swagger * components: * schemas: * Book: * type: object * required: * - title * - author * - finished * properties: * id: * type: integer * description: The auto-generated id of the book. * title: * type: string * description: The title of your book. * author: * type: string * description: Who wrote the book? * finished: * type: boolean * description: Have you finished reading it? * createdAt: * type: string * format: date * description: The date of the record creation. * example: * title: The Pragmatic Programmer * author: Andy Hunt / Dave Thomas * finished: true */

/** * @swagger * tags: * name: Books * description: API to manage your books. */ /** * @swagger * path: * /books/: * post: * summary: Creates a new book * tags: [Books] * requestBody: * required: true * content: * application/json: * schema: * $ref: "#/components/schemas/Book" * responses: * "200": * description: The created book. * content: * application/json: * schema: * $ref: "#/components/schemas/Book" */

// [rootDir]/routes/books.js /** * @swagger * tags: * name: Books * description: API to manage your books. * paths: * /books/: * get: * summary: Lists all the books * tags: [Books] * responses: * "200": * description: The list of books. * content: * application/json: * schema: * $ref: "#/components/schemas/Book" * post: * summary: Creates a new book * tags: [Books] * requestBody: * required: true * content: * application/json: * schema: * $ref: "#/components/schemas/Book" * responses: * "200": * description: The created book. * content: * application/json: * schema: * $ref: "#/components/schemas/Book" * /books/{id}: * get: * summary: Gets a book by id * tags: [Books] * parameters: * - in: path * name: id * schema: * type: integer * required: true * description: The book id * responses: * "200": * description: The list of books. * content: * application/json: * schema: * $ref: "#/components/schemas/Book" * "404": * description: Book not found. * put: * summary: Updates a book * tags: [Books] * parameters: * - in: path * name: id * schema: * type: integer * required: true * description: The book id * requestBody: * required: true * content: * application/json: * schema: * $ref: "#/components/schemas/Book" * responses: * "204": * description: Update was successful. * "404": * description: Book not found. * delete: * summary: Deletes a book by id * tags: [Books] * parameters: * - in: path * name: id * schema: * type: integer * required: true * description: The book id * responses: * "204": * description: Delete was successful. * "404": * description: Book not found. * components: * schemas: * Book: * type: object * required: * - title * - author * - finished * properties: * id: * type: integer * description: The auto-generated id of the book. * title: * type: string * description: The title of your book. * author: * type: string * description: Who wrote the book? * finished: * type: boolean * description: Have you finished reading it? * createdAt: * type: string * format: date * description: The date of the record creation. * example: * title: The Pragmatic Programmer * author: Andy Hunt / Dave Thomas * finished: true */ const express = require("express"); const router = express.Router(); const books = require("../util/data"); router.get("/", function (req, res) { res.status(200).json(books); }); router.get("/:id", function (req, res) { let book = books.find(function (item) { return item.id == req.params.id; }); book ? res.status(200).json(book) : res.sendStatus(404); }); router.post("/", function (req, res) { const { title, author, finished } = req.body; let book = { id: books.length + 1, title: title, author: author, finished: finished !== undefined ? finished : false, createdAt: new Date(), }; books.push(book); res.status(201).json(book); }); router.put("/:id", function (req, res) { let book = books.find(function (item) { return item.id == req.params.id; }); if (book) { const { title, author, finished } = req.body; let updated = { id: book.id, title: title !== undefined ? title : book.title, author: author !== undefined ? author : book.author, finished: finished !== undefined ? finished : book.finished, createdAt: book.createdAt, }; books.splice(books.indexOf(book), 1, updated); res.sendStatus(204); } else { res.sendStatus(404); } }); router.delete("/:id", function (req, res) { let book = books.find(function (item) { return item.id == req.params.id; }); if (book) { books.splice(books.indexOf(book), 1); } else { return res.sendStatus(404); } res.sendStatus(204); }); module.exports = router;

// [rootDir]/server.js var express = require("express"), bodyParser = require("body-parser"), swaggerJsdoc = require("swagger-jsdoc"), swaggerUi = require("swagger-ui-express"); const app = express(); app.use( bodyParser.urlencoded({ extended: true, }) ); app.use(bodyParser.json()); app.use("/books", require("./routes/books")); const options = { definition: { openapi: "3.0.0", info: { title: "LogRocket Express API with Swagger", version: "0.1.0", description: "This is a simple CRUD API application made with Express and documented with Swagger", license: { name: "MIT", url: "https://spdx.org/licenses/MIT.html", }, contact: { name: "LogRocket", url: "https://logrocket.com", email: "info@email.com", }, }, servers: [ { url: "http://localhost:3000", }, ], }, apis: ["./routes/books.js"], }; const specs = swaggerJsdoc(options); app.use( "/api-docs", swaggerUi.serve, swaggerUi.setup(specs, { explorer: true }) ); const PORT = process.env.PORT || 3000; app.listen(PORT); console.debug("Server listening on port: " + PORT);