ProtocApi

<back to all web services

Protoc

The following routes are available for this service:
All Verbs/protoc/{Lang}
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class Protoc
    {
        public ProtocLang lang = null;
        public HashMap<String,String> files = null;
        public String protoUrl = null;
        
        public ProtocLang getLang() { return lang; }
        public Protoc setLang(ProtocLang value) { this.lang = value; return this; }
        public HashMap<String,String> getFiles() { return files; }
        public Protoc setFiles(HashMap<String,String> value) { this.files = value; return this; }
        public String getProtoUrl() { return protoUrl; }
        public Protoc setProtoUrl(String value) { this.protoUrl = value; return this; }
    }

    @DataContract
    public static enum ProtocLang
    {
        Cpp,
        CSharp,
        Dart,
        Java,
        JavaLite,
        ObjectiveC,
        Php,
        Python,
        Ruby,
        Go,
        JavaScriptClosure,
        JavaScriptCommonJs,
        JavaScriptNodeJs,
        Swift,
        TypeScript,
        TypeScriptBinary;
    }

    public static class ProtocResponse
    {
        public ProtocLang lang = null;
        public HashMap<String,String> generatedFiles = null;
        public String archiveUrl = null;
        public ResponseStatus responseStatus = null;
        
        public ProtocLang getLang() { return lang; }
        public ProtocResponse setLang(ProtocLang value) { this.lang = value; return this; }
        public HashMap<String,String> getGeneratedFiles() { return generatedFiles; }
        public ProtocResponse setGeneratedFiles(HashMap<String,String> value) { this.generatedFiles = value; return this; }
        public String getArchiveUrl() { return archiveUrl; }
        public ProtocResponse setArchiveUrl(String value) { this.archiveUrl = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public ProtocResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

}

Java Protoc DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /protoc/{Lang} HTTP/1.1 
Host: grpc.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Protoc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProtocApi.ServiceModel">
  <Files xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Files>
  <Lang>cpp</Lang>
  <ProtoUrl>String</ProtoUrl>
</Protoc>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ProtocResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProtocApi.ServiceModel">
  <ArchiveUrl>String</ArchiveUrl>
  <GeneratedFiles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </GeneratedFiles>
  <Lang>cpp</Lang>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</ProtocResponse>