.NET WebAPI에서 Swagger를 사용한 문서 생성
기존 자료를 참고해도 NuGet 패키지 찾기 어려움이 발생할 수 있어 직접 경험을 정리합니다.
프로젝트는 .NET 4.5 기반으로 진행하며 Swagger-Net과 Swashbuckle.Net45 패키지를 사용했습니다.
프로젝트 속성->빌드->출력에서 XML 문서 파일 생성 체크박스를 활성화합니다.
서비스 실행 후 다음 주소로 접근하면 됩니다:
프로젝트 주소/swagger/ui/index
메서드 주석 ...
9월 12일 07:18에 게시됨
Spring Boot에서 Swagger를 사용한 자동 API 문서 생성
Swagger는 RESTful API의 설계, 빌드, 문서화를 위한 오픈소스 프레임워크로, Spring Boot와 결합하면 개발 중인 API에 대한 실시간 문서를 자동으로 생성할 수 있다. 이를 통해 클라이언트 개발자나 테스트 엔지니어가 API 명세를 쉽게 확인할 수 있다.
Maven 의존성 추가
Spring Boot 2.6 이상에서는 springfox-boot-starter 대신 OpenAPI 3 기반의 springdoc-openapi-s ...
9월 10일 03:51에 게시됨
.NET Core + EF Core를 사용한 데이터베이스 API 컨트롤러 구현 가이드
필요한 모든 코드를 한 번에 제공합니다. 복사하여 바로 사용할 수 있습니다!
필수 패키지 설치 (명령어 실행)
NuGet 패키지 관리자 콘솔에서 다음 명령어를 실행하세요:
bash
Install-Package Microsoft.EntityFrameworkCore
Install-Package Microsoft.EntityFrameworkCore.SqlServer
Install-Package Swashbuckle.AspNetCore
엔터티 클래스 정의 (테이블 구조)
M ...
9월 3일 11:53에 게시됨
Swagger를 활용한 REST API 문서 자동화
개요
Swagger는 RESTful 웹 서비스의 설계, 생성, 호출 및 시각화를 지원하는 표준 프레임워크입니다.
이 도구를 통해 서버 코드와 문서가 동기화되며, 클라이언트 측에서도 최신 상태의 API 정보를 실시간으로 접근할 수 있습니다.
특히 개발 중에는 빠른 테스트와 문서 확인이 가능하고, 생산 환경에서는 비활성화하여 보안을 강화할 수 있습니다.
Spring Boot와 Swa ...
7월 26일 00:03에 게시됨
ASP.NET Core Web API 개발: Swagger와 Entity Framework Core Code-First 적용
RESTful API를 개발할 때 API 문서화는 필수적인 요소입니다. Swagger(현 OpenAPI Specification)는 REST API를 위한 표준화되고 언어 독립적인 인터페이스를 정의하는 것을 목표로 합니다. 이를 통해 개발자와 시스템 모두 소스 코드나 별도의 문서 없이도 다양한 서비스의 기능을 쉽게 파악하고 이해할 수 있습니다. Swagger로 API가 정의되면, 클라이언트는 최소한의 구 ...
7월 21일 03:21에 게시됨
ASP.NET JWT 인증 구현 가이드
1. NuGet 패키지 설치
JWT 라이브러리를 NuGet을 통해 프로젝트에 추가합니다. JWT 패키지를 설치해야 합니다.
2. JWT 헬퍼 클래스 작성
using JWT;
using JWT.Algorithms;
using JWT.Exceptions;
using JWT.Serializers;
using System;
using System.Collections.Generic;
namespace ProjectName.Tool
{
public class JwtTokenHelper
{
private static ...
7월 1일 00:08에 게시됨
Spring Boot 환경에서 JWT 인터셉터 구축 및 Knife4j 문서 접근 이슈 해결
프로젝트에 JWT 기능을 추가하기 위해 pom.xml에 다음 의존성을 추가합니다.
<dependency>
<groupId>com.auth0</groupId>
<artifactId>java-jwt</artifactId>
<version>4.4.0</version>
</dependency>
JWT 유틸리티 클래스
토큰의 생성과 검증을 담당하는 유틸리티 클래스를 작성합니다.
TokenManager
pa ...
6월 21일 20:46에 게시됨
.NET 5에서 Swagger를 통한 JWT 인증 활성화
Startup.cs 파일 수정
수정이 필요한 주요 부분은 서비스 구성 및 미들웨어 파이프라인 설정입니다.
미들웨어 순서 확인
app.UseAuthentication();
app.UseAuthorization();
이 두 줄의 순서는 매우 중요합니다. 인증 처리는 반드시 권한 검사보다 먼저 이루어져야 합니다. 즉, 사용자 신원을 먼저 확인한 후, 그 사용자가 접근할 수 있는 리소스를 판단해야 하므로, ...
6월 20일 22:19에 게시됨
Flasgger를 활용한 Flask API 문서화 가이드
프로젝트 개요
Flasgger는 Flask 애플리케이션에서 OpenAPI 스펙을 자동 추출하고, Swagger UI를 통해 API를 시각적으로 탐색하고 테스트할 수 있게 해주는 확장 라이브러리입니다. YAML, Python 딕셔너리, Marshmallow 스키마 등 다양한 방식으로 데이터 유효성을 검증할 수 있어 API 개발 생산성을 크게 향상시킵니다.
환경 설정 및 설치
먼저 가상 환경을 생성하고 ...
5월 24일 09:11에 게시됨