aspnet api

Aspnet-Api

최소 ASP.NET Core API

요구 사항

• .NET 8.0 SDK
• MySQL 데이터베이스

특징

• Openapi
• 종속성 주입 컨테이너 (자동화 링 포함)
• 단일 액션 컨트롤러, 서비스 및 리포지토리
• 환경 별 구성
• 12- 요인 .env 구성 로더 (민감한 데이터 용)
• MySQL 데이터베이스 연결
• SQL QueryBuilder (SQLKATA)
• 데이터베이스 트랜잭션 처리
• 입력 유효성 검사 (유동 범위화)
• ValidationException 미들웨어
• 현지화 (ngetText)
• 컨텍스트 별 로깅 (Serilog)
• 파일 기반 오류 로깅
• GitHub 동작을 사용한 지속적인 통합 (CI) 워크 플로
• 데이터베이스 마이그레이션 (DBUP)

테스트

• xunit 테스트
• HTTP 엔드 포인트 테스트 (테스트 데이터베이스 사용)
• 로그 메시지에 대한 유창한 주장

TODO

• 데이터베이스 테스트에 대한 유창한 어설 션
• 인증 (Basicauth)
• 스크립트를 빌드하십시오

설치

새 프로젝트를 만들려면 다음 명령을 실행하십시오.

 git clone https://github.com/odan/aspnet-api.git --depth 1 {my-app-name}
cd {my-app-name}

{my-app-name} 프로젝트의 원하는 이름으로 바꾸십시오.

새로운 MySQL / MariaDB 데이터베이스를 만듭니다.

 CREATE DATABASE ` my_api ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

그에 따라 데이터베이스 이름을 수정하십시오.

MyApi 디렉토리에서 .env 파일을 만듭니다.

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api

그에 따라 데이터베이스 및 자격 증명을 수정하십시오.

schema.sql 파일을 수동으로 가져 오거나 다음 명령을 실행하십시오.

 npm run migration:migrate

참고 : 이 명령에는 NPM이 필요합니다.

명령

디버그 모드에서 응용 프로그램을 빌드하고 실행하려면 실행하십시오.

 dotnet run

또는

 dotnet watch run

릴리스 빌드 실행 :

 dotnet run --configuration Release

프로젝트 및 그 종속성 구축 :

 dotnet build

릴리스 구성을 사용하여 프로젝트 및 그 종속성 구축 :

 dotnet build --configuration Release

빈 및 OBJ 디렉토리 청소 :

 dotnet clean

깨끗하고 건축 :

 dotnet rebuild

게시 :

 dotnet publish

코드 스타일

dotnet-format 패키지 설치 :

 dotnet tool install --global dotnet-format 

코드 스타일 확인 :

 dotnet format --verify-no-changes

코드 스타일 수정 :

 dotnet format -v d

번역

메시지를 번역 해야하는 IStringLocalizer<T> 인터페이스를 선언하십시오.

예

 public class Example
{
    private readonly IStringLocalizer < Example > _localizer ;

    public Example ( IStringLocalizer < Example > localizer )
    {
        _localizer = localizer ;
    }

    // ...
}

번역 사용

기본 및 소스 언어는 영어입니다.

간단한 메시지 번역 :

 string text = _localizer . GetString ( "Hello, World!" ) ;

// Output: Hallo, Welt!

자리 표시 자로 메시지를 변환 :

 string text2 = _localizer . GetString ( "The user {0} logged in" , "sally" ) ;

// Output: Der Benutzer sally hat sich eingeloggt

새 번역 파일 생성

• POEDIT를 열고 프로젝트 Resources 디렉토리에서 새 PO 번역 파일을 만듭니다.
• 파일 이름은 문화 이름 (예 : de-DE.po 과 동일해야합니다.
• 메뉴 Translations > Settings 엽니 다
• PO 언어를 변경하십시오 (예 : German
• 소스 키워드로 _localizer.GetString 추가하십시오.
• 프로젝트 CS 파일에 소스 경로를 추가하십시오.
• 파일을 저장하고 새 번역을 위해 Update from source 클릭하십시오.
• 메시지를 변환하고 파일을 저장하여 Mo 파일 (예 : de-DE.mo 을 생성하십시오.

언어 변경

CurrentCulture를 다음과 같이 설정하여 요청 중에 언어를 변경할 수 있습니다.

 using using System . Globalization ;
// ...

var culture = new CultureInfo ( "de-DE" ) ;
Thread . CurrentThread . CurrentCulture = culture ;
Thread . CurrentThread . CurrentUICulture = culture ;

LocalizationMiddleware HTTP 요청 Accept-Language 헤더 값을 사용하여 사용자 언어를 감지합니다. 이 헤더에 유효한 코드가 포함되어 있으면 CurrentCulture가 자동으로 전환됩니다.

테스트

Xunit 용 로컬 테스트 데이터베이스를 만듭니다.

 CREATE DATABASE ` my_api_test ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

MyApi.Tests 디렉토리에서 .env 파일을 만듭니다.

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api_test

그에 따라 데이터베이스 및 자격 증명을 수정하십시오.

테스트 스위트를 시작하려면 실행하십시오.

 dotnet test

특허

MIT 라이센스 (MIT). 자세한 내용은 라이센스 파일을 참조하십시오.