Skip to content

Commit

Permalink
Merge pull request #275 from boostcampwm-2024/chore/static-files-swag…
Browse files Browse the repository at this point in the history
…ger-endpoint

📦chore: 프로덕션 서버 위치 변경 및 정적 파일 추가 / 스웨거 endpoint 변경
  • Loading branch information
asn6878 authored Dec 3, 2024
2 parents 021c725 + 1b8b08b commit 89fa7d2
Show file tree
Hide file tree
Showing 9 changed files with 50 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
export NVM_DIR=~/.nvm
source ~/.nvm/nvm.sh
cd /root/web05-Denamu
cd /var/web05-Denamu
git pull origin main
cd server/
Expand Down
20 changes: 16 additions & 4 deletions server/src/common/swagger/swagger.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,23 @@ import { DocumentBuilder, SwaggerModule } from '@nestjs/swagger';

export function setupSwagger(app: INestApplication) {
const config = new DocumentBuilder()
.setTitle('Denamu')
.setDescription('개발자들의 이야기가 자라나는 곳, 데나무🎋 API 명세서')
.setTitle('Denamu API')
.setDescription(
'개발자들의 이야기가 자라나는 곳, 데나무🎋 API 명세서입니다.\n\n' +
'이 문서를 통해 모든 API 엔드포인트와 요청/응답 형식을 확인할 수 있습니다. ' +
'데나무 API는 RESTful 구조를 기반으로 하며, 다양한 개발자 커뮤니케이션을 지원합니다.',
)
.setVersion('1.0')
.addTag('Admin', '관리자 전용 API')
.addTag('Feed', '피드 관리와 검색 관련 API')
.addTag('RSS', '관리자 전용 API')
.addTag('Statistic', '통계 정보 조회 API')
.setLicense('MIT License', 'https://opensource.org/licenses/MIT')
.build();

const documentFactory = () => SwaggerModule.createDocument(app, config);
SwaggerModule.setup('api-docs', app, documentFactory);
const document = SwaggerModule.createDocument(app, config);

SwaggerModule.setup('api/swagger', app, document, {
customSiteTitle: 'Denamu API Docs',
});
}
Binary file added static/Denamu_Logo_KOR.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/Denamu_Logo_KOR.webp
Binary file not shown.
1 change: 1 addition & 0 deletions static/github-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/images.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions static/medium-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions static/tistory-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions static/velog-icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 89fa7d2

Please sign in to comment.