ProtocApi

<back to all web services

Protoc

The following routes are available for this service:
All Verbs/protoc/{Lang}
"use strict";
/** @typedef {'cpp'|'csharp'|'dart'|'java'|'java-lite'|'objc'|'php'|'python'|'ruby'|'go'|'js-closure'|'js-commonjs'|'js-node'|'swift'|'ts'|'ts-binary'} */
export var ProtocLang;
(function (ProtocLang) {
    ProtocLang["Cpp"] = "cpp"
    ProtocLang["CSharp"] = "csharp"
    ProtocLang["Dart"] = "dart"
    ProtocLang["Java"] = "java"
    ProtocLang["JavaLite"] = "java-lite"
    ProtocLang["ObjectiveC"] = "objc"
    ProtocLang["Php"] = "php"
    ProtocLang["Python"] = "python"
    ProtocLang["Ruby"] = "ruby"
    ProtocLang["Go"] = "go"
    ProtocLang["JavaScriptClosure"] = "js-closure"
    ProtocLang["JavaScriptCommonJs"] = "js-commonjs"
    ProtocLang["JavaScriptNodeJs"] = "js-node"
    ProtocLang["Swift"] = "swift"
    ProtocLang["TypeScript"] = "ts"
    ProtocLang["TypeScriptBinary"] = "ts-binary"
})(ProtocLang || (ProtocLang = {}));
export class ProtocResponse {
    /** @param {{lang?:ProtocLang,generatedFiles?:{ [index: string]: string; },archiveUrl?:string,responseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ProtocLang} */
    lang;
    /** @type {{ [index: string]: string; }} */
    generatedFiles;
    /** @type {string} */
    archiveUrl;
    /** @type {ResponseStatus} */
    responseStatus;
}
export class Protoc {
    /** @param {{lang?:ProtocLang,files?:{ [index: string]: string; },protoUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ProtocLang} */
    lang;
    /** @type {{ [index: string]: string; }} */
    files;
    /** @type {string} */
    protoUrl;
}

JavaScript 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>