dotnet webapi playground

C# dotnet 웹 API 놀이터(많은 예제 + Docker 배포)

문맥

Docker 컨테이너(Kubernetes, Google Cloud Run, 서버리스 플랫폼 등)에 잘 문서화되고 배포된 RESTful 마이크로서비스를 게시해야 하는 경우가 많습니다.

이 플레이그라운드 프로젝트는 프로젝트에서 재사용할 수 있는 많은 기능을 보여줍니다.

이는 라이브 프로젝트이므로 자주 업데이트될 것입니다.

이 응용 프로그램의 기능은 무엇입니까?

• 앱은 많은 일을 합니다. 프로젝트를 실행하면 많은 웹 API 엔드포인트가 노출됩니다.
• 문서 참조(프로젝트 실행 시 기본 페이지)

프로젝트의 스택 및 주요 주제

• .NET 6.0 webapi 애플리케이션

  • 기음#
  • REST 웹API
  • 객체와 Json 파서
  • 반환 코드(HTTP StatusCodes) 조작
  • 메모리 캐싱
  • 해싱 생성 및 해시 검증
  • 네이티브 C# 데이터 유형 확장/재정의

• 도커

  • 도커 빌드
  • 도커 실행
  • 도커 컨테이너 http/https 상호 작용

작성자 및 라이센스 정보

• Erick은 수석 백엔드 개발자이자 설계자입니다.
• 이메일 [email protected] 또는 Linkedin https://www.linkedin.com/in/seixaserick/을 통해 Erick에게 연락할 수 있습니다.
• 기타 Github 저장소: https://github.com/seixaserick/
• MIT 라이선스(자세한 ​​내용은 LICENSE.txt를 확인하세요)

이 프로젝트를 실행하는 방법

저장소 복제

이미 Windows용 Git을 설치한 경우 아래 명령을 실행하세요.

 git clone https://github.com/seixaserick/dotnet-webapi-playground
cd dotnet-webapi-playground

Docker 컨테이너에서 이 프로젝트를 실행하는 방법

Docker Desktop을 이미 설치한 경우 아래 단계를 따르세요.

도커 이미지 만들기

Docker 이미지를 생성하려면 프로젝트 디렉터리의 명령 프롬프트에서 아래 명령줄을 실행하세요.

 docker build -t dotnet-webapi-playground -f Dockerfile .

Docker 컨테이너에서 앱 실행

Redis 인스턴스가 없는 경우 Docker에서 Redis 서버를 설정하세요.

 docker run --name redis -d -p 6379:6379 -e REDIS_PASSWORD=supersecretpassword --restart always redis:latest /bin/sh -c 'redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}'

Docker 컨테이너에서 이미지를 실행하고 상호작용하려면 아래 명령줄을 실행하세요.

 docker run -it -p 1977:80 --name=dotnet-webapi-playground --restart=always dotnet-webapi-playground

열기: http://localhost:1977/square/8(https 제외)

컨테이너를 중지하려면 아래 명령줄을 실행하세요.

 docker stop dotnet-webapi-playground

컨테이너를 제거하려면(실행 중인 경우에도) 아래 명령줄을 실행하세요.

 docker rm --force dotnet-webapi-playground

Docker 없이 빌드하고 실행하는 방법(Windows)

리포지토리를 복제한 후 Visual Studio를 사용하여 프로젝트를 열 수 있습니다. F5 눌러 빌드하거나 디버그하세요.

Windows에서 컴파일하고 실행하려면 (Visual Studio 필요)

Visual Studio에서 솔루션 파일 dotnet-webapi-playground.sln 연 다음 F5 눌러 프로젝트를 실행하세요!

테이크아웃

• Swagger는 훌륭한 문서 생성기입니다.
• C# WebApi는 256MB RAM 미만의 Docker 컨테이너 내에서 실행하기에 매우 가볍습니다.
• Json Parse는 닷넷을 통해 쉽고 가벼운 방식으로 만들어졌습니다.
• Docker는 종속성 및 구성에 대한 걱정 없이 프로젝트를 빠르게 실행할 수 있는 훌륭한 도구입니다.
• C#은 다른 ECMA 기반 언어(Java, Javascript 등)와 매우 유사합니다.
• 해싱 알고리즘은 "단방향"입니다. 특정 해시에서 입력 문자열을 복구할 수 없습니다.
• 응답 코드는 API 응답에서 쉽게 사용자 정의할 수 있습니다(예: HTTP 409 충돌, HTTP 402 PaymentRequired 등). 전체 HTTP 응답 코드를 참조하세요.
• 좋은 Markdown README.md 파일은 다른 개발자가 프로젝트를 이해, 복제, 실행 및 테스트하는 데 도움이 될 수 있습니다.

숙제 도전

1. Models 폴더에 새 개체 모델을 만들고 새 API 끝점(HTTP GET 메서드)을 만들어 몇 가지 계산을 수행하고 이 새 개체를 반환합니다.
2. 새로운 C# 데이터 유형 확장을 생성하고 이를 사용하여 기본 데이터 유형을 조작합니다. 예: .ToBase64Encode() 수행하기 위한 string extension 만든 다음 inputString.ToBase64Encode(); 시도해 볼 수 있습니다. 대신 함수 접근 방식.
3. 일부 개체를 수신하고 이를 사용하여 작업을 수행하여 결과를 반환하는 새 POST API 엔드포인트를 만듭니다.
4. 일부 엔드포인트에서 Redis 분산 캐시를 구현해 보세요.