Lista przykładów internetowego interfejsu API

Przykłady HttpClient

Przykład tłumaczenia Bing | Źródło VS 2012

Pokazuje, jak wywołać usługę Microsoft Translator przy użyciu klasy HttpClient . Interfejs API usługi Microsoft Translator wymaga tokenu OAuth, który uzyskuje aplikacja, wysyłając żądanie do serwera tokenów platformy Azure dla każdego żądania do usługi translatora. Wynik z serwera tokenów jest wprowadzany do żądania wysłanego do usługi tłumaczenia. Przed uruchomieniem tego przykładu należy uzyskać klucz aplikacji z witryny Azure Marketplace i wypełnić informacje w przykładowej klasie AccessTokenMessageHandler.

Przykład Google Maps | szczegółowy opis | Kod źródłowy VS 2012

Używa klienta HttpClient do pobrania mapy Redmond, WA z interfejsu API usługi Google Maps, zapisuje go jako plik lokalny i otwiera domyślną przeglądarkę obrazów.

Przykład klienta Twittera | szczegółowy opis | kod źródłowy VS 2012

Pokazuje, jak napisać prostego klienta usługi Twitter przy użyciu klienta HttpClient. W przykładzie użyto HttpMessageHandler do wstawienia informacji uwierzytelniania OAuth do wychodzącej wiadomości HttpRequestMessage. Wynik z usługi Twitter jest odczytywany przy użyciu JSON.NET. Przed uruchomieniem tego przykładu należy uzyskać klucz aplikacji z usługi Twitter i wypełnić informacje w przykładowej klasie OAuthMessageHandler.

Przykład Banku Światowego | szczegółowy opis | Źródło VS 2010 | Źródło VS 2012

Pokazuje, jak pobrać dane z witryny danych Banku Światowego przy użyciu JSON.NET, aby przeanalizować wynik.

Przykłady internetowego interfejsu API

Wprowadzenie do internetowego interfejsu API ASP.NET | Źródło programu VS 2012

Przedstawia sposób tworzenia podstawowego internetowego interfejsu API obsługującego żądania HTTP GET. Zawiera kod źródłowy samouczka Twój pierwszy ASP.NET internetowy interfejs API.

Scenariusze JavaScript dla ASP.NET Web API – Komentarze | Źródło VS 2012

Pokazuje, jak używać ASP.NET Web API do tworzenia interfejsów API, które obsługują klientów przeglądarkowych i można je łatwo wywoływać przy użyciu jQuery.

Menedżer kontaktów | Źródło programu VS 2010

W tym przykładzie użyto ASP.NET Web API do utworzenia prostej aplikacji menedżera kontaktów. Aplikacja składa się z internetowego interfejsu API menedżera kontaktów, który jest używany przez aplikację ASP.NET MVC i aplikację systemu Windows Phone do wyświetlania listy kontaktów i zarządzania nimi.

Przykład dzielenia na partie | szczegółowy opis | Źródło programu VS 2012

Pokazuje, jak zaimplementować przetwarzanie wsadowe HTTP w ASP.NET. Wsadowe umieszczanie żądań polega na umieszczaniu wielu żądań HTTP w jednej treści jednostki wieloczęściowej MIME, która jest następnie wysyłana na serwer jako żądanie HTTP POST. Żądania są przetwarzane indywidualnie, a odpowiedzi są umieszczane w inną wieloczęściową jednostkę MIME, która jest zwracana do klienta.

Przykład kontrolera zawartości | szczegółowy opis | Źródło programu VS 2010 | Źródło programu VS 2012

Pokazuje, jak odczytywać i zapisywać jednostki żądań i odpowiedzi asynchronicznie przy użyciu strumieni. Przykładowy kontroler ma dwie akcje: akcję PUT, która odczytuje treść jednostki żądania asynchronicznie i przechowuje ją w pliku lokalnym, oraz akcję GET zwracającą zawartość pliku lokalnego.

Przykład rozwiązywania niestandardowego zestawu | Kod źródłowy VS 2012

Pokazuje, jak zmodyfikować ASP.NET internetowy interfejs API w celu obsługi odnajdywania kontrolerów z dynamicznie załadowanego zestawu biblioteki. Przykład implementuje niestandardowy element IAssembliesResolver , który wywołuje implementację domyślną, a następnie dodaje zestaw biblioteki do domyślnych wyników.

Niestandardowy formater typu multimediów - przykład | szczegółowy opis | Kod źródłowy VS 2010

Przedstawia sposób tworzenia niestandardowego formatatora typów multimediów przy użyciu klasy bazowej BufferedMediaTypeFormatter . Ta klasa bazowa jest przeznaczona dla formaterów, które korzystają głównie z synchronicznych operacji odczytu i zapisu. Oprócz wyświetlania formatowania typu mediów, przykład pokazuje, jak go zarejestrować w ramach konfiguracji HttpConfiguration dla aplikacji. Należy pamiętać, że można również bezpośrednio użyć klasy bazowej MediaTypeFormatter w przypadku formaterów, które korzystają głównie z asynchronicznych operacji odczytu i zapisu.

Przykład powiązania parametrów niestandardowych | szczegółowy opis | Kod źródłowy VS 2010

Pokazuje sposób dostosowywania procesu powiązania parametrów, czyli procesu określającego, w jaki sposób informacje z żądania są powiązane z parametrami akcji. W tym przykładzie kontroler strony głównej ma cztery akcje:

1. BindPrincipal pokazuje, jak powiązać parametr IPrincipal z niestandardowego ogólnego podmiotu zabezpieczeń, a nie z komunikatu HTTP GET.
2. BindCustomComplexTypeFromUriOrBody pokazuje, jak powiązać parametr typu złożonego, który może pochodzić z treści komunikatu lub z URI żądania HTTP POST.
3. BindCustomComplexTypeFromUriWithRenamedProperty pokazuje, jak powiązać parametr typu złożonego z właściwością o zmienionej nazwie, którą dostarcza identyfikator URI żądania POST HTTP.
4. PostMultipleParametersFromBody pokazuje, jak powiązać wiele parametrów z treści komunikatu POST;

Przykład przekazywania plików | szczegółowy opis | Źródło programu VS 2012

Pokazuje, jak przekazywać pliki do interfejsu ApiController przy użyciu funkcji przekazywania plików wieloczęściowych MIME oraz jak skonfigurować powiadomienia o postępie za pomocą klienta HttpClient przy użyciu programu ProgressNotificationHandler. Kontroler odczytuje zawartość pliku HTML przekazywanego asynchronicznie i zapisuje co najmniej jedną część treści w pliku lokalnym. Odpowiedź zawiera informacje o przekazanym pliku (lub plikach).

Przykład przekazywania plików do usługi Azure Blob Store | szczegółowy opis | Źródło programu VS 2012

Ten przykład jest podobny do przykładu przesyłania plików, ale zamiast zapisywać przesłane pliki na dysku lokalnym, asynchronicznie przesyła pliki do magazynu obiektów blob platformy Azure przy użyciu .NET SDK dla platformy Windows Azure. Udostępnia również mechanizm wyświetlania listy obiektów blob znajdujących się obecnie w kontenerze usługi Azure Blob Storage. Możesz wypróbować przykład uruchomiony dla emulatora usługi Azure Storage , który jest dostarczany z zestawem Azure SDK. Jeśli masz konto usługi Azure Storage, możesz również testować na rzeczywistej usłudze magazynowania.

Przykładowy | szczegółowy opis | Źródło programu VS 2010

Pokazuje, jak połączyć wystąpienia HttpMessageHandler zarówno na kliencie (HttpClient), jak i na serwerze (ASP.NET Web API). W przykładzie ta sama procedura obsługi jest używana zarówno na kliencie, jak i serwerze. Chociaż rzadko ta sama procedura obsługi będzie uruchamiana w obu miejscach, model obiektów jest taki sam po stronie klienta i serwera.

Przykład | Źródło programu VS 2012

Przedstawia sposób przekazywania i pobierania kodu JSON do i z interfejsu ApiController. W przykładzie użyto minimalnego kontrolera ApiController i uzyskano do niego dostęp przy użyciu HttpClient.

Przykład mashupu | szczegółowego opisu | Źródło programu VS 2012

Pokazuje, jak uzyskać dostęp do wielu lokacji zdalnych asynchronicznie z poziomu akcji ApiController . Za każdym razem, gdy akcja zostaje uruchomiona, żądania są zlecane asynchronicznie, dzięki czemu nie są blokowane żadne wątki.

Przykład śledzenia pamięci | szczegółowy opis | Źródło programu VS 2010

Ten przykładowy projekt tworzy pakiet NuGet, który zainstaluje niestandardowy moduł śledzenia w pamięci w aplikacjach ASP.NET Web API.

Przykład bazy danych | MongoDBszczegółowy opis | Źródło programu VS 2012

Pokazuje, jak używać bazy danych MongoDB jako trwałego magazynu dla kontrolera ApiController przy użyciu wzorca repozytorium.

Przykład procesora treści odpowiedzi | Źródło VS 2012

Pokazuje, jak skopiować jednostkę odpowiedzi (czyli treść odpowiedzi HTTP) do pliku lokalnego przed jego przesłaniem do klienta i wykonać dodatkowe przetwarzanie w tym pliku asynchronicznie. W przykładzie zaimplementowano program HttpMessageHandler, który opakowuje odpowiedź obiektem, który zapisuje się zarówno w danych wyjściowych w standardowy sposób, jak i do pliku lokalnego.

Przekaż Przykład XDocument | szczegółowy opis | Kod źródłowy VS 2012

Pokazuje, jak przesłać dokument XDocument do ApiController przy użyciu PushStreamContent i HttpClient.

Przykład walidacyjny | Źródło VS 2010

Pokazuje, jak można użyć atrybutów weryfikacji w modelach w ASP.NET WebAPI w celu zweryfikowania zawartości żądania HTTP. Pokazuje, jak oznaczyć właściwości zgodnie z potrzebami, jak używać atrybutów weryfikacji zdefiniowanych przez platformę i niestandardowych do dodawania adnotacji do modelu oraz jak zwracać odpowiedzi o błędach dla nieprawidłowych stanów modelu.

Przykład formularza internetowego | szczegółowy opis | Źródło programu VS 2010

Pokazuje element ApiController dodany do projektu Web Forms.

Przykład RestBugs

RestBugs to prosta aplikacja do śledzenia usterek, która pokazuje, jak używać internetowego interfejsu API ASP.NET i nowej biblioteki klienta HTTP w celu utworzenia systemu opartego na hipermediach. Przykład obejmuje implementacje klienta i serwera przy użyciu internetowego interfejsu API ASP.NET. Serwer używa niestandardowego formatowania Razor do generowania reprezentacji zasobów. Przykład udostępnia również serwer node.js, aby zilustrować korzyści wynikające z używania projektu hipermedia do oddzielenia klientów i serwerów.