전체 글

[ASP.NET Core Web API] Swagger와 API 명세

백엔드에서 API를 만들고 나면 프런트엔드에서 이를 활용하기 위해 어떤 방법으로 필요한 데이터를 전송하고 받을지에 대한 설명서가 필요합니다. 이를 API명세라고도 하며 Swagger를 사용하면 API명세가 담긴 UI를 손쉽게 생성할 수 있고 테스트도 가능합니다. Swagger를 사용하기 위해서는 우선 NuGet Package에서 'Swashbuckle.AspNetCore'를 검색해 해당 Package를 설치해 줍니다. 그리고 startup.cs에서 ConfigureServices() 메서드에서 다음과 같이 API 문서의 제목과 버전 정보 등을 등록합니다. services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "myapi", ..

[ASP.NET Core Web API] 파일업로드(FileUpload)

파일 업로드 API가 들어갈 컨트롤러가 Home이라는 가정하에 다음과 같이 생성자를 추가합니다. private readonly IWebHostEnvironment _environment; public HomeController(IWebHostEnvironment enviroment) { _environment = enviroment; } IWebHostEnvironment 인터페이스로부터 받는 WebHostEnvironment 객체는 현재 root 폴더의 경로를 알 수 있도록 하며 이를 기준으로 업로드할 폴더를 찾아들어갈 것입니다. 주의할 점은 ASP.NET Core로 순수 Web API 프로젝트를 만들게 되면 wwwroot폴더는 프로젝트에 포함되지 않을 수 있는데 이런 경우 생성자로부터 받는 envir..

[ASP.NET Core Web API] DI (Dependency Injection) 구현 (Autofac)

시작하기 전 NuGet Package에서 Autofac과 Autofac.Extensions.DependencyInjection 패키지를 검색해 내려받고 설치합니다. 패키지 설치가 완료되면 우선 DI를 적용할 대상 인터페이스를 작성합니다. public interface IRepository { dbContext Data(); } 위 인터페이스는 dbContext를 반환하는 Data() 메서드를 선언하고 있으며 해당 인터페이스를 상속받아 인터페이스에서 정의한 메서드를 구현합니다. public class Repository : IRepository { public dbContext Data() { return new dbContext(); } } 작성된 클래스는 데이터베이스의 Entity 객체를 반환하는 클래..

[ASP.NET Core Web API] JWT 인증

JWT(JSON Web Token)는 전통적인 폼 로그인 방식이 아닌 Token이라는 일련의 암호화된 문자열을 통해서 클라이언트와 서버 간의 인증을 처리하는 방식입니다. ASP.NET Core를 통해 Web API 구현할 때도 JWT를 통한 인증방식을 구현할 수 있습니다. 우선 Web API 프로젝트를 생성하고 startup.cs의 ConfigureServices 메서드에 아래와 같은 코드를 추가해 JWT 인증 스키마를 등록합니다. services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme).AddJwtBearer(options => { options.RequireHttpsMetadata = false; options.SaveToken = tru..

[.NET Core] DB로 부터 Model 생성하기 (MySQL/MariaDB)

Entity Framework을 통해 Model(Entity -> 이하 Model이라고 칭함)을 만들면 모델에 따라 DataBase에 Table을 생성할 수 있습니다. 그런데 키나 값의 제약조건 등 다양한 테이블의 속성을 정확하게 Model로 구현하기가 까다로울뿐더러 Table의 개수가 수십 개가 되면 그와 매핑되는 모델을 만들어 주기도 어려웠습니다. Core이전에는 'ADO.NET Entity Data Model'을 사용했지만 Core는 아직 같은 기능으로 사용할 수 있는 건 없는 듯합니다. 따라서 차라리 직접 Database에 Query나 전용 Tool을 사용해 Table을 생성한 다음 만들어진 Table을 대상으로 Model을 가져오는 편이 나을지도 모르며. 이 글에서는 이러한 방법을 안내하고자 합..

[nestjs] TypeORM 기존 테이블에서 entity 생성하기

TypeORM을 사용하려면 우선 만들고자 하는 테이블의 사양에 맞게 Entity를 생성해 줘야 합니다. 문제는 이게 TypeORM에 익숙하지 않으면 무척 피곤한 일이라는 건데 다행스럽게도 만들어진 테이블에서 entity를 생성하는 방법이 있습니다. 우선 필요한 테이블을 DB 전용의 툴을 사용해 만들거나 sql 구분으로 만든 다음에 역으로 TypeORM의 entity를 만들어 이걸 nestjs와 연결해 사용하면 될 듯합니다. 설치방법은 아래와 같습니다. npm i -g typeorm-model-generator 설치 후에는 다음의 명령어로 entity를 생성할 수 있습니다. typeorm-model-generator -h localhost -d school -p 3306 -u root -x 1234 -e ..

[MariaDB] ubuntu 에서 MariaDB 완전 삭제

apt-get purge mariadb-server apt-get purge mariadb-common

[nestjs] spec과 unit testing

nestjs구조를 보면 거의 모든 controller.ts와 service ts파일에 spec.ts파일이 같이 붙어 있는 것을 볼 수 있습니다. spec.ts파일은 테스트를 위한 파일입니다. import { Test, TestingModule } from '@nestjs/testing'; import { SchoolController } from './school.controller'; describe('SchoolController', () => { let controller: SchoolController; beforeEach(async () => { const module: TestingModule = await Test.createTestingModule({ controllers: [SchoolC..