c# api 예제

ActionResult 반환 형식은 광범위한 HTTP 상태 코드를 나타낼 수 있습니다. 예를 들어 GetTodoItem은 [HttpGet] 특성에 경로 템플릿(예: [HttpGet(“제품”)]이 있는 경우 경로에 이 값을 추가할 수 있습니다. 이 샘플에서는 템플릿을 사용하지 않습니다. 자세한 내용은 Http[동사] 특성이 있는 특성 라우팅을 참조하세요. 웹 개발 경로를 사용함으로써 조만간 외부 API(응용 프로그램 프로그래밍 인터페이스)를 처리해야 합니다. 이 문서에서 는 C# 프로젝트에서 RESTful API를 사용하는 가장 포괄적인 방법 목록을 만들고 몇 가지 간단한 예제에서 이를 수행하는 방법을 보여 주는 것이 목표입니다. 기사를 읽은 후에는 어떤 옵션을 사용할 수 있는지, 다음에 RESTful API를 사용해야 할 때 올바른 옵션을 선택하는 방법에 대한 더 많은 통찰력을 갖게 됩니다. 더미 사용자 목록과 함께 기본 예제를 준비했습니다. 이해하기 쉽게 하기 위해 몇 가지 예제를 제공합시다(공식 문서에서 나온 것입니다): JSON 응답이 자동으로 형식 캐스팅되고 있음을 언급할 가치가 있습니다.

두 번째 예제에서 볼 수 있듯이 메서드의 반환 값은 Task<List>입니다. 따라서 라이브러리는 우리의 유형에 대한 응답을 캐스팅 할 만큼 똑똑합니다 (Json.NET 의존). 그것은 우리의 삶을 훨씬 더 쉽게 만듭니다. 요약하자면 RESTful API를 사용하는 데 사용할 수 있는 다양한 도구에 대해 이야기했습니다. HttpWebRequest, WebClient 및 HttpClient와 같은 작업을 수행 할 수있는 몇 가지 .NET 라이브러리와 RestSharp 및 ServiceStack과 같은 놀라운 타사 도구 중 일부에 대해 언급했습니다. 또한 이러한 도구에 대한 매우 짧은 소개를 제공했으며 도구를 사용하는 방법을 보여 주는 몇 가지 매우 간단한 예제를 만들었습니다. HttpClient는 “블록의 새로운 아이”이며 이전 라이브러리가 부족한 최신 .NET 기능 중 일부를 제공합니다. 예를 들어, HttpClient의 단일 인스턴스를 사용하여 여러 요청을 보낼 수 있으며, 특정 HTTP 서버 또는 호스트에 연결되지 않고 비동기/await 메커니즘을 사용합니다. jQuery를 얻는 방법에는 여러 가지가 있습니다. 이 예제에서는 Microsoft Ajax CDN을 사용했습니다. 또한 http://jquery.com/ 다운로드할 수 있으며 ASP.NET “웹 API” 프로젝트 템플릿에는 jQuery도 포함되어 있습니다.

브라우저 또는 Postman에서 두 끝점을 호출하여 응용 프로그램을 테스트합니다. 예: 상대 URI “api/products/”에 대한 항목을 찾습니다. 이 항목을 선택하고 상세 보기로 이동을 클릭합니다. 세부 정보 보기에는 요청 및 응답 헤더와 본보기를 볼 수 있는 탭이 있습니다. 예를 들어 헤더 요청 탭을 클릭하면 클라이언트가 Accept 헤더에서 “응용 프로그램/json”을 요청한 것을 볼 수 있습니다. URI를 붙여 넣기 (예 https://localhost:5001/api/TodoItems/1) 이제 기본적인 예제를 만들어 보겠습니다. 이 자습서에서는 모든 시스템의 매우 일반적인 엔터티/개체인 사용자를 위한 API를 준비합니다. 예제를 단순하게 유지하기 위해 제품은 컨트롤러 클래스 내부의 고정 배열에 저장됩니다. 물론 실제 응용 프로그램에서는 데이터베이스를 쿼리하거나 다른 외부 데이터 원본을 사용합니다. 간단한 예이지만 양식 정보 게시, 권한 부여 등과 같은 보다 정교한 시나리오를 처리해야 할 때 훨씬 더 복잡해집니다. 이 예제는 데모용으로 웹 서버의 캐시를 저장소 매체로 사용하여 세션 저장소 메커니즘 이나 요청 저장소 수명을 사용하는 대신 여러 클라이언트에서 동시에 값을 사용할 수 있도록 합니다.