Конечные точки REST / SOAP для службы WCF

Question

У меня есть служба WCF, и я хочу представить ее как службу RESTfull и как службу SOAP. Кто-нибудь делал что-то подобное раньше?

Answer 1

Вы можете выставить услугу в двух разных конечных точках. SOAP можно использовать привязку, которая поддерживает SOAP, например, basicHttpBinding, RESTful можно использовать webHttpBinding. Я предполагаю, что ваша служба REST будет в JSON, в этом случае вам нужно настроить две конечные точки со следующей конфигурацией поведения

<endpointBehaviors>
  <behavior name="jsonBehavior">
    <enableWebScript/>
  </behavior>
</endpointBehaviors>

Пример конфигурации конечной точки в вашем сценарии:

<services>
  <service name="TestService">
    <endpoint address="soap" binding="basicHttpBinding" contract="ITestService"/>
    <endpoint address="json" binding="webHttpBinding"  behaviorConfiguration="jsonBehavior" contract="ITestService"/>
  </service>
</services>

так, услуга будет доступна на

• http://www.example.com/soap
• http://www.example.com/json

Примените [WebGet] к договору операции, чтобы сделать его RESTful. например,

public interface ITestService
{
   [OperationContract]
   [WebGet]
   string HelloWorld(string text)
}

Обратите внимание: если служба REST отсутствует в JSON, параметры операций не могут содержать сложный тип.

Ответ на сообщение для SOAP и RESTful POX (XML)

Для простого старого XML в качестве возвращаемого формата это пример, который будет работать как для SOAP, так и для XML.

[ServiceContract(Namespace = "http://test")]
public interface ITestService
{
    [OperationContract]
    [WebGet(UriTemplate = "accounts/{id}")]
    Account[] GetAccount(string id);
}

Поведение POX для REST Обычный старый XML

<behavior name="poxBehavior">
  <webHttp/>
</behavior>

Endpoints

<services>
  <service name="TestService">
    <endpoint address="soap" binding="basicHttpBinding" contract="ITestService"/>
    <endpoint address="xml" binding="webHttpBinding"  behaviorConfiguration="poxBehavior" contract="ITestService"/>
  </service>
</services>

Услуга будет доступна на

• http://www.example.com/soap
• http://www.example.com/xml

запрос REST попробуйте в браузере,

http://www.example.com/xml/accounts/A123

SOAP-запрос конфигурация клиентской конечной точки для службы SOAP после добавления ссылки на службу,

  <client>
    <endpoint address="http://www.example.com/soap" binding="basicHttpBinding"
      contract="ITestService" name="BasicHttpBinding_ITestService" />
  </client>

в C #

TestServiceClient client = new TestServiceClient();
client.GetAccount("A123");

Другой способ сделать это - выставить два разных сервисных контракта и каждый со своей конфигурацией. Это может привести к появлению дубликатов на уровне кода, однако в конце дня вы захотите заставить его работать.

Answer 2

На этот пост уже получен очень хороший ответ от "Сообщества вики", и я также рекомендую посмотреть веб-блог Рика Строла, там много хороших постов о WCF.

Я использовал оба, чтобы получить этот вид MyService-сервиса ... Тогда я могу использовать REST-интерфейс из jQuery или SOAP из Java.

Это из моего Web.Config:

<system.serviceModel>
 <services>
  <service name="MyService" behaviorConfiguration="MyServiceBehavior">
   <endpoint name="rest" address="" binding="webHttpBinding" contract="MyService" behaviorConfiguration="restBehavior"/>
   <endpoint name="mex" address="mex" binding="mexHttpBinding" contract="MyService"/>
   <endpoint name="soap" address="soap" binding="basicHttpBinding" contract="MyService"/>
  </service>
 </services>
 <behaviors>
  <serviceBehaviors>
   <behavior name="MyServiceBehavior">
    <serviceMetadata httpGetEnabled="true"/>
    <serviceDebug includeExceptionDetailInFaults="true" />
   </behavior>
  </serviceBehaviors>
  <endpointBehaviors>
   <behavior name="restBehavior">
    <webHttp/>
   </behavior>
  </endpointBehaviors>
 </behaviors>
</system.serviceModel>

А это мой класс обслуживания (.svc-codebehind, интерфейсы не требуются):

    /// <summary> MyService documentation here ;) </summary>
[ServiceContract(Name = "MyService", Namespace = "http://myservice/", SessionMode = SessionMode.NotAllowed)]
//[ServiceKnownType(typeof (IList<MyDataContractTypes>))]
[ServiceBehavior(Name = "MyService", Namespace = "http://myservice/")]
public class MyService
{
    [OperationContract(Name = "MyResource1")]
    [WebGet(ResponseFormat = WebMessageFormat.Xml, UriTemplate = "MyXmlResource/{key}")]
    public string MyResource1(string key)
    {
        return "Test: " + key;
    }

    [OperationContract(Name = "MyResource2")]
    [WebGet(ResponseFormat = WebMessageFormat.Json, UriTemplate = "MyJsonResource/{key}")]
    public string MyResource2(string key)
    {
        return "Test: " + key;
    }
}

На самом деле я использую только Json или Xml, но они оба здесь для демонстрационных целей. Это GET-запросы для получения данных. Для вставки данных я бы использовал метод с атрибутами:

[OperationContract(Name = "MyResourceSave")]
[WebInvoke(Method = "POST", ResponseFormat = WebMessageFormat.Json, UriTemplate = "MyJsonResource")]
public string MyResourceSave(string thing){
    //...

Answer 3

Если вы хотите разработать только один веб-сервис и разместить его на разных конечных точках (т. Е. SOAP + REST, с выходами XML, JSON, CSV, HTML). Вам также следует рассмотреть возможность использования ServiceStack , который я построил именно для этой цели, когда каждый разрабатываемый вами сервис автоматически доступен как на конечных точках SOAP, так и на REST без дополнительных настроек. любая конфигурация требуется.

В примере Hello World показано, как создать простой сервис с помощью just (не требуется настройка):

public class Hello {
    public string Name { get; set; }
}

public class HelloResponse {
    public string Result { get; set; }
}

public class HelloService : IService
{
    public object Any(Hello request)
    {
        return new HelloResponse { Result = "Hello, " + request.Name };
    }
}

Никаких других настроек не требуется, и эта услуга сразу же доступна с REST в:

• SOAP
• XML
• JSON
• HTML

Он также поставляется с дружественным HTML-выводом (при вызове с HTTP-клиентом с Accept: text / html например, браузером), так что вы можете лучше визуализировать результаты ваших услуг.

Обработка различных глаголов REST также тривиальна, вот полное CRUD-приложение REST-service на 1 странице C # (меньше, чем требуется для настройки WCF;):

• Приложение TODO для внешнего интерфейса
• Реализация внутренней службы REST

Answer 4

В MSDN сейчас есть статья для этого:

https://msdn.microsoft.com/en-us/library/bb412196(v=vs.110).aspx

Вступление:

По умолчанию Windows Communication Foundation (WCF) делает конечные точки доступными только для клиентов SOAP. В разделе Практическое руководство. Создание базовой веб-службы WCF HTTP конечная точка становится доступной для клиентов, не являющихся SOAP. Могут возникнуть ситуации, когда вы захотите сделать один и тот же контракт доступным в обоих случаях, в качестве конечной точки Web и конечной точки SOAP. В этом разделе показан пример того, как это сделать.

Answer 5

Мы должны определить конфигурацию поведения для REST конечная точка

<endpointBehaviors>
  <behavior name="restfulBehavior">
   <webHttp defaultOutgoingResponseFormat="Json" defaultBodyStyle="Wrapped" automaticFormatSelectionEnabled="False" />
  </behavior>
</endpointBehaviors>

а также к услуге

<serviceBehaviors>
   <behavior>
     <serviceMetadata httpGetEnabled="true" httpsGetEnabled="true" />
      <serviceDebug includeExceptionDetailInFaults="false" />
   </behavior>
</serviceBehaviors>

После поведения следующим шагом являются привязки. Например, BasicHttpBinding для SOAP конечной точки и webHttpBinding для REST .

<bindings>
   <basicHttpBinding>
     <binding name="soapService" />
   </basicHttpBinding>
   <webHttpBinding>
     <binding name="jsonp" crossDomainScriptAccessEnabled="true" />
   </webHttpBinding>
</bindings>

Наконец, мы должны определить 2 конечную точку в определении сервиса. Внимание для адреса = "" конечной точки, где службе REST ничего не нужно.

<services>
  <service name="ComposerWcf.ComposerService">
    <endpoint address="" behaviorConfiguration="restfulBehavior" binding="webHttpBinding" bindingConfiguration="jsonp" name="jsonService" contract="ComposerWcf.Interface.IComposerService" />
    <endpoint address="soap" binding="basicHttpBinding" name="soapService" contract="ComposerWcf.Interface.IComposerService" />
    <endpoint address="mex" binding="mexHttpBinding" name="metadata" contract="IMetadataExchange" />
  </service>
</services>

В интерфейсе сервиса мы определяем операцию с ее атрибутами.

namespace ComposerWcf.Interface
{
    [ServiceContract]
    public interface IComposerService
    {
        [OperationContract]
        [WebInvoke(Method = "GET", UriTemplate = "/autenticationInfo/{app_id}/{access_token}", ResponseFormat = WebMessageFormat.Json,
            RequestFormat = WebMessageFormat.Json, BodyStyle = WebMessageBodyStyle.Wrapped)]
        Task<UserCacheComplexType_RootObject> autenticationInfo(string app_id, string access_token);
    }
}

Присоединение ко всем сторонам, это будет наше определение system.serviceModel WCF.

<system.serviceModel>

  <behaviors>
    <endpointBehaviors>
      <behavior name="restfulBehavior">
        <webHttp defaultOutgoingResponseFormat="Json" defaultBodyStyle="Wrapped" automaticFormatSelectionEnabled="False" />
      </behavior>
    </endpointBehaviors>
    <serviceBehaviors>
      <behavior>
        <serviceMetadata httpGetEnabled="true" httpsGetEnabled="true" />
        <serviceDebug includeExceptionDetailInFaults="false" />
      </behavior>
    </serviceBehaviors>
  </behaviors>

  <bindings>
    <basicHttpBinding>
      <binding name="soapService" />
    </basicHttpBinding>
    <webHttpBinding>
      <binding name="jsonp" crossDomainScriptAccessEnabled="true" />
    </webHttpBinding>
  </bindings>

  <protocolMapping>
    <add binding="basicHttpsBinding" scheme="https" />
  </protocolMapping>

  <serviceHostingEnvironment aspNetCompatibilityEnabled="true" multipleSiteBindingsEnabled="true" />

  <services>
    <service name="ComposerWcf.ComposerService">
      <endpoint address="" behaviorConfiguration="restfulBehavior" binding="webHttpBinding" bindingConfiguration="jsonp" name="jsonService" contract="ComposerWcf.Interface.IComposerService" />
      <endpoint address="soap" binding="basicHttpBinding" name="soapService" contract="ComposerWcf.Interface.IComposerService" />
      <endpoint address="mex" binding="mexHttpBinding" name="metadata" contract="IMetadataExchange" />
    </service>
  </services>

</system.serviceModel>

Чтобы протестировать обе конечные точки, мы можем использовать WCFClient до SOAP и PostMan до REST .

Answer 6

Это то, что я сделал, чтобы это работало. Убедитесь, что вы положили
webHttp automaticFormatSelectionEnabled = "true" внутри поведения конечной точки.

[ServiceContract]
public interface ITestService
{

    [WebGet(BodyStyle = WebMessageBodyStyle.Bare, UriTemplate = "/product", ResponseFormat = WebMessageFormat.Json)]
    string GetData();
}

public class TestService : ITestService
{
    public string GetJsonData()
    {
        return "I am good...";
    }
}

Внутренняя сервисная модель

   <service name="TechCity.Business.TestService">

    <endpoint address="soap" binding="basicHttpBinding" name="SoapTest"
      bindingName="BasicSoap" contract="TechCity.Interfaces.ITestService" />
    <endpoint address="mex"
              contract="IMetadataExchange" binding="mexHttpBinding"/>
    <endpoint behaviorConfiguration="jsonBehavior" binding="webHttpBinding"
              name="Http" contract="TechCity.Interfaces.ITestService" />
    <host>
      <baseAddresses>
        <add baseAddress="http://localhost:8739/test" />
      </baseAddresses>
    </host>
  </service>

Поведение конечной точки

  <endpointBehaviors>
    <behavior name="jsonBehavior">
      <webHttp automaticFormatSelectionEnabled="true"  />
      <!-- use JSON serialization -->
    </behavior>
  </endpointBehaviors>