ProtocApi

<back to all web services

Protoc

The following routes are available for this service:
All Verbs/protoc/{Lang}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

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

class ProtocResponse implements IConvertible
{
    ProtocLang? lang;
    Map<String,String?>? generatedFiles;
    String? archiveUrl;
    ResponseStatus? responseStatus;

    ProtocResponse({this.lang,this.generatedFiles,this.archiveUrl,this.responseStatus});
    ProtocResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        lang = JsonConverters.fromJson(json['lang'],'ProtocLang',context!);
        generatedFiles = JsonConverters.toStringMap(json['generatedFiles']);
        archiveUrl = json['archiveUrl'];
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'lang': JsonConverters.toJson(lang,'ProtocLang',context!),
        'generatedFiles': generatedFiles,
        'archiveUrl': archiveUrl,
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ProtocResponse";
    TypeContext? context = _ctx;
}

class Protoc implements IConvertible
{
    ProtocLang? lang;
    Map<String,String?>? files;
    String? protoUrl;

    Protoc({this.lang,this.files,this.protoUrl});
    Protoc.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        lang = JsonConverters.fromJson(json['lang'],'ProtocLang',context!);
        files = JsonConverters.toStringMap(json['files']);
        protoUrl = json['protoUrl'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'lang': JsonConverters.toJson(lang,'ProtocLang',context!),
        'files': files,
        'protoUrl': protoUrl
    };

    getTypeName() => "Protoc";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'grpc.servicestack.net', types: <String, TypeInfo> {
    'ProtocLang': TypeInfo(TypeOf.Enum, enumValues:ProtocLang.values),
    'ProtocResponse': TypeInfo(TypeOf.Class, create:() => ProtocResponse()),
    'Protoc': TypeInfo(TypeOf.Class, create:() => Protoc()),
});

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