Различия

Показаны различия между двумя версиями страницы.

--- swagger_-_napisannja_dokumentaciji [2024/06/27 17:06]
tro
+++ swagger_-_napisannja_dokumentaciji [2024/06/30 10:54] (текущий)
tro
@@ Строка 62: / Строка 62: @@
 </code>
+В цьому файлі ми бачимо, що нам треба створити ще файли docs/index.html та docs/openapi.yaml. Створимо їх з наступним вмістом
+<code>
+<!-- docs/index.html -->
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <title>API Reference | ReDoc</title>
+  <!-- needed for adaptive design -->
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <link rel="icon" type="image/png" href="favicon.png">
+  <!--
+    ReDoc uses font options from the parent element
+    So override default browser styles
+    -->
+  <style>
+    body {
+      margin: 0;
+      padding: 0;
+    }
+  </style>
+  {{{redocHead}}}
+</head>
+<body>
+  {{{redocHTML}}}
+</body>
+</html>
+</code>
+<code>
+# docs/openapi.yaml
+openapi: 3.1.0
+info:
+  version: 1.0.0
+  title: Students app
+  license:
+    name: Apache 2.0
+    url: <http://www.apache.org/licenses/LICENSE-2.0.html>
+  description: >
+    This is a documentation of students app
+tags:
+  - name: Students
+    description: Operations about users.
+  - name: Auth
+    description: Auth operations.
+servers:
+  - url: <http://localhost:3000>
+  - url: <https://example.com/api/v1>
+paths:
+components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+</code>
+===== Бібліотека Swagger UI Express для публікації документаціїї swagger на сервері =====
+[[https://www.npmjs.com/package/swagger-ui-express|Swagger UI Express - публікації документаціїї ]]
+===== Розширення для VSCode Redocly OpenAPI: =====
+Також перед початком написання документації ми радимо вам встановити розширення у VSCOde [[https://marketplace.visualstudio.com/items?itemName=Redocly.openapi-vs-code|Redocly OpenAPI]]
+===== Використання =====
+==== preview ====
+<code>
+npm run preview-docs
+</code>
+Перегляд попередньої збудованої сторінки буде доступний на **http://127.0.0.1:8080/**
+Взагалі в терміналі треба читати - там пише на який порт і куди сервіс запуститься.