Czym są interfejsy API REST dla usług Reporting Services?

Dotyczy: SQL Server Reporting Services (2017 i nowsze wersje) Serwer Raportów usługi Power BI

Usługi Microsoft SQL Server 2017 Reporting Services obsługują interfejsy API usługi Representational State Transfer (REST). Interfejsy API REST to punkty końcowe usługi, które obsługują zestaw operacji HTTP (metod). Te metody umożliwiają tworzenie, pobieranie, aktualizowanie lub usuwanie dostępu do zasobów na serwerze raportów.

Interfejs API REST zapewnia programowy dostęp do obiektów w katalogu serwera raportów SQL Server 2017 Reporting Services. Poniżej przedstawiono przykłady obiektów:

• Folderów
• Reports
• Wskaźniki KPI
• Źródła danych
• Zbiory danych
• Odświeżanie planów
• Subskrypcje

W przypadku korzystania z interfejsu API REST można nawigować po hierarchii folderów, odnajdywać zawartość folderu lub pobierać definicję raportu. Można również tworzyć, aktualizować i usuwać obiekty.

Składniki żądania/odpowiedzi interfejsu API REST

Para żądań/odpowiedzi interfejsu API REST może być rozdzielona na pięć składników:

• Identyfikator URI żądania:

  • Mimo że identyfikator URI żądania jest zawarty w nagłówku komunikatu żądania, większość języków lub struktur wymaga przekazania go oddzielnie od komunikatu żądania.
  • Składa się z .{URI-scheme} :// {URI-host} / {resource-path} ? {query-string}

  Żądanie URI	Description
  Schemat identyfikatora URI	Wskazuje protokół używany do przesyłania żądania. Na przykład: http lub https.
  Host identyfikatora URI	Określa nazwę domeny lub adres IP serwera, na którym jest hostowany punkt końcowy usługi REST, na przykład myserver.contoso.com.
  Ścieżka zasobu	Określa zasób lub kolekcję zasobów, która może zawierać wiele segmentów używanych przez usługę podczas określania wyboru tych zasobów. Na przykład można użyć CatalogItems(01234567-89ab-cdef-0123-456789abcdef)/Properties, aby pobrać określone właściwości dla CatalogItem.
  Ciąg zapytania (opcjonalnie)	Udostępnia bardziej proste parametry, takie jak wersja interfejsu API lub kryteria wyboru zasobów.

• Pola nagłówkowe komunikatu żądania HTTP:

  • Wymagana metoda HTTP, znana również jako operacja lub czasownik.
  • Informuje usługę o typie żądanej operacji. Interfejsy API REST usług Reporting Services obsługują metody DELETE, GET, HEAD, PUT, POST i PATCH.
  • Opcjonalne dodatkowe pola nagłówka zgodnie z wymaganiami określonego identyfikatora URI i metody HTTP.

• Opcjonalne pola treści komunikatu żądania HTTP:

  • Obsługuje identyfikator URI i operację HTTP. Na przykład operacje POST zawierają obiekty zakodowane w formacie MIME (Multipurpose Internet Mail Extensions), które są przekazywane jako złożone parametry.
  • W przypadku operacji POST lub PUT typ kodowania MIME dla treści powinien być również określony w nagłówku Content-type żądania. Niektóre usługi wymagają użycia określonego typu MIME, takiego jak application/json.

• Pola nagłówka komunikatu odpowiedzi HTTP:

  • Kod stanu HTTP, od kodów powodzenia 2xx do kodów błędów 4xx lub 5xx. Alternatywnie może zostać zwrócony kod stanu zdefiniowany przez usługę, zgodnie z opisem w dokumentacji interfejsu API.
  • Opcjonalne dodatkowe pola nagłówka, jakie są wymagane do obsługi odpowiedzi na żądanie, takie jak nagłówek odpowiedzi Content-type.

• Opcjonalne pola treści komunikatu odpowiedzi HTTP:

  • Obiekty odpowiedzi zakodowane w formacie MIME są zwracane w treści odpowiedzi HTTP, takie jak odpowiedź z metody GET zwracającej dane. Zazwyczaj te obiekty są zwracane w formacie ustrukturyzowanym, takim jak JSON lub XML, zgodnie z nagłówkiem Content-type odpowiedzi.

Dokumentacja interfejsu API

Nowoczesny interfejs API REST wymaga nowoczesnej dokumentacji API. Interfejs REST API jest oparty na specyfikacji OpenAPI, znanej również jako specyfikacja Swagger. Dokumentacja interfejsu API REST serwera raportów usługi Power BI jest dostępna w witrynie Microsoft Learn.

Testowanie wywołań interfejsu API

Jeśli potrzebujesz narzędzia do testowania komunikatów żądań/odpowiedzi HTTP, program Fiddler jest bezpłatnym serwerem proxy debugowania internetowego, który może przechwytywać żądania REST, co ułatwia diagnozowanie komunikatów żądania/odpowiedzi HTTP.

Treści powiązane

• Korzystanie z interfejsów API REST serwera raportów usługi Power BI
• Przykłady Reporting-Services
• Spróbuj zapytać na forum Reporting Services