National_Parks_API

국립공원 데이터베이스 API(C# ASP .NET 애플리케이션)

크리스타 루츠

사용자가 GitHub에서 호스팅되는 국립공원에 대한 정보를 얻고 게시할 수 있는 API 애플리케이션입니다. 마지막 업데이트 날짜: 2020년 4월 3일.

설명

이 애플리케이션을 사용하면 사용자는 국립공원에 대한 데이터베이스 항목을 생성하여 이름, 주, 공원 코드, 지역, 웹사이트 URL 및 공원 개방 여부에 대한 메모를 추가할 수 있습니다. 기능을 추가하고 삭제하는 것 외에도 공원을 가져오고 게시하는 기능이 포함되어 있습니다.

이 프로젝트는 MVC 패턴 라이브러리 및 SQL 데이터베이스를 사용하여 ASP.NET Core 웹 처리 기능을 갖춘 .NET Core 플랫폼에서 C#으로 개발되었습니다. 특히 이 앱은 스키마를 생성하기 위해 Entity Framework 및 MySQL을 사용하여 구축되었으며 GitHub에서 호스팅됩니다.

이는 C# 및 .NET 과정 6주차인 "API 구축"의 Epicodus 13주차 금요일 독립 프로젝트를 위해 만들어졌습니다.

에피코더스 스킬:

• 기음#
• MVC 패턴(ASP .NET Core 2.2 사용)
• RESTful 라우팅 및 CRUD
• 엔터티 프레임워크 마이그레이션
• MySQL 워크벤치 및 서버
• 행동 중심 개발(BDD)
• Git 버전 제어 및 GitHub
• RESTful API 구축

설치/설정

이 API는 완전히 문서화되어 있습니다. API 문서 문서에서 사용법과 설명을 찾아보세요.

이 프로그램을 로컬에서 실행하려면 저장소를 다운로드하거나 복제하세요!

이 프로그램을 실행하려면 .NET Core SDK가 필요합니다. 다음은 Mac 또는 Windows 10에 .NET을 설치하기 위한 무료 자습서입니다.

이 프로그램은 또한 SQL 데이터베이스를 사용합니다. 데이터베이스를 구축하려면 MySQL Workbench를 사용하는 것이 좋습니다. 다음은 Mac 또는 Windows 10에 MySQL WorkBench 및 MySQL Community Server를 설치하기 위한 무료 튜토리얼입니다.

• 이 저장소를 다운로드하거나 복제하세요.
  • ZIP을 다운로드하려면:
    • GitHub Repository 사이트에서 "다운로드"를 선택하세요.
    • 다운로드가 완료되면 ZIP을 열고 파일을 추출합니다. 새 폴더는 'Week-13-Building-an-API-C-Sharp'로 생성됩니다.
  • 복제하려면:
    • 명령줄에서 데스크탑으로 복제: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • 새 디렉터리는 'Desktop/Week-12-Advanced-Databases-and-Authentication-Project'로 생성됩니다.
• 파일을 로컬에 저장한 후 다음 명령을 실행하십시오.
  • 응용 프로그램 디렉터리로 이동합니다: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • $ dotnet ef database update
  • $ dotnet build
  • $ dotnet run
• 성공하면 프로그램이 콘솔에서 실행되기 시작합니다.

사용된 기술

• .NET 코어 2.2
  • C#의 서버측
• MySQL 데이터베이스
• 우편 집배원

명세서

주립공원과 국립공원을 위한 API를 만듭니다. API에는 주립공원과 국립공원이 나열됩니다. 포함할 기능은 다음과 같습니다.

• 애플리케이션에는 CRUD 기능이 포함되어 있으며 API 호출에 대한 응답을 성공적으로 반환합니다.
• 애플리케이션에는 인증, 버전 관리, 페이지 매김, Swagger 문서 또는 CORS와 같은 추가 탐색 목표 중 하나 이상이 포함됩니다.
• 추가 조사에 대한 구체적인 문서를 포함하여 응용 프로그램이 잘 문서화되어 있습니다.
• 코드 검토 요구 사항을 완료한 후에는 월요일의 추가 탐색에서 다른 기능을 추가하는 것을 고려해 보세요. 창의력을 발휘하고 다른 사용자 지정 경로, 범위 및 기능도 추가하세요. 고려해야 할 몇 가지 다른 가능성은 다음과 같습니다.
  • 공원을 무작위로 반환하는 RANDOM 엔드포인트를 추가하세요.
  • 매개변수를 허용하는 두 번째 사용자 지정 엔드포인트를 추가합니다. 예: 사용자가 특정 공원 이름으로 검색할 수 있는 SEARCH 경로.

귀하의 코드는 다음 목적을 위해 검토됩니다.

• 애플리케이션에는 CRUD 기능이 포함되어 있으며 API 호출에 대한 응답을 성공적으로 반환합니다.

• 애플리케이션에는 인증, 버전 관리, 페이지 매김, Swagger 문서 또는 CORS와 같은 추가 탐색 목표 중 하나 이상이 포함됩니다.

• 추가 조사에 대한 구체적인 문서를 포함하여 응용 프로그램이 잘 문서화되어 있습니다.

• 커밋 기록에는 8시간의 작업이 명확하게 표시됩니다.

알려진 버그

• 알려진 버그 없음

지원 및 연락처 세부정보

문제가 발생하거나 질문, 아이디어 또는 우려사항이 있는 경우 저에게 연락해 주세요. [email protected]로 연락하실 수 있습니다. 업데이트에 대한 풀 요청을 자유롭게 작성하세요. 코드에 대한 기여가 권장됩니다!

특허

저작권 (c) 2020 크리스타 루츠

이 소프트웨어는 MIT 라이선스에 따라 라이선스가 부여됩니다.

라이선스 세부정보 보기

본 소프트웨어 및 관련 문서 파일("소프트웨어")의 사본을 취득한 모든 사람에게 사용, 복사, 수정, 병합에 대한 권리를 포함하되 이에 국한되지 않고 제한 없이 소프트웨어를 취급할 수 있는 권한이 무료로 부여됩니다. , 소프트웨어 사본을 게시, 배포, 재라이센스 부여 및/또는 판매하고, 소프트웨어를 제공받은 사람에게 다음 조건에 따라 그렇게 하도록 허용합니다.

위의 저작권 고지와 본 허가 고지는 소프트웨어의 모든 사본 또는 상당 부분에 포함됩니다.

소프트웨어는 상품성, 특정 목적에의 적합성 및 비침해에 대한 보증을 포함하되 이에 국한되지 않고 명시적이든 묵시적이든 어떠한 종류의 보증 없이 "있는 그대로" 제공됩니다. 어떠한 경우에도 작성자나 저작권 보유자는 계약, 불법 행위 또는 기타 행위로 인해 소프트웨어나 사용 또는 기타 거래와 관련하여 발생하는 모든 청구, 손해 또는 기타 책임에 대해 책임을 지지 않습니다. 소프트웨어.