작성
·
314
·
수정됨
답변 2
0
가능하면 vite를 사용하는 것을 추천합니다.
cra는 webpack, vite는 rollup 이라서 번들링할 때 차이가 많이 있습니다.
npm install swagger-ui-express swagger-jsdoc
CRA로 저도 시도해보겠습니다.
일단 AI에게 물어 봤습니다.
Swagger를 사용하여 API 문서화를 진행하려면, swagger-ui-express
라이브러리를 사용할 수 있습니다. 이 라이브러리를 사용하면 Swagger UI를 Express 애플리케이션에 쉽게 통합할 수 있습니다.
먼저, swagger-ui-express
와 yamljs
를 설치해야 합니다. 이 라이브러리들은 Swagger 정의를 로드하고 처리하는 데 사용됩니다.
npm install swagger-ui-express yamljs
그런 다음, index.js
파일에 Swagger UI를 설정하고, 이를 Express 애플리케이션에 연결해야 합니다.
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const swaggerDocument = YAML.load('./swagger.yaml');
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));
위의 코드에서 './swagger.yaml'
은 Swagger 정의 파일의 경로입니다. 이 파일은 API의 모든 엔드포인트와 관련된 정보를 포함해야 합니다.
그러나, 질문에서 언급한대로 routes 디렉토리가 없는 경우, swagger.yaml
파일에 모든 API 경로를 명시적으로 선언해야 합니다. 이렇게 하면 Swagger가 API 문서를 생성하고 표시할 수 있습니다.
마지막으로, apis: ["./index.js"]
와 같이 작성하면, Swagger는 index.js
파일을 통해 API 정의를 가져오려고 시도합니다. 이 파일에는 API 엔드포인트에 대한 정보가 포함되어야 합니다.
이 방식을 사용하면, Swagger를 사용하여 API 문서를 생성하고 표시할 수 있습니다. 이렇게 하면, 개발자가 API를 이해하고 사용하는 데 도움이 됩니다.
from: https://www.phind.com/search?cache=bcs8i2d5sfcxohzc2e9zzi1n
0
vite 사용안하고 cra로 적용하신 상세한 가이드 문서가 있으시면 공유 부탁드립니다. 상세 설명 없이 따라가는 강의라..ㅠㅠ 환경도 많이 달라서 적용이 거의 안되네요
프론트 , 백 분리 되어 있고
ec2 인스턴스는 우분투입니다.
피드백 너무 감사합니다!! hello는 찍었고 지금 http는 디비에서 까지 잘 가져오는데 https 로는 502가 뜨고 브라우저에서는 hello도 뜨지 않고있습니다..ㅠㅠㅠ
ec2도 바꾸셨네요.
저도 시도해 보겠습니다.
정보 감사해요.