Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weโ€™ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

๐Ÿ“ฆchore: ํ”„๋กœ๋•์…˜ ์„œ๋ฒ„ ์œ„์น˜ ๋ณ€๊ฒฝ ๋ฐ ์ •์  ํŒŒ์ผ ์ถ”๊ฐ€ / ์Šค์›จ๊ฑฐ endpoint ๋ณ€๊ฒฝ #275

Merged
merged 4 commits into from
Dec 3, 2024
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.
Loading