ProtocApi

Protoc

The following routes are available for this service:
All Verbs	/protoc/{Lang}

<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


// @DataContract
enum ProtocLang : string
{
    case Cpp = 'cpp';
    case CSharp = 'csharp';
    case Dart = 'dart';
    case Java = 'java';
    case JavaLite = 'java-lite';
    case ObjectiveC = 'objc';
    case Php = 'php';
    case Python = 'python';
    case Ruby = 'ruby';
    case Go = 'go';
    case JavaScriptClosure = 'js-closure';
    case JavaScriptCommonJs = 'js-commonjs';
    case JavaScriptNodeJs = 'js-node';
    case Swift = 'swift';
    case TypeScript = 'ts';
    case TypeScriptBinary = 'ts-binary';
}

class ProtocResponse implements JsonSerializable
{
    public function __construct(
        /** @var ProtocLang|null */
        public ?ProtocLang $lang=null,
        /** @var array<string,string>|null */
        public ?array $generatedFiles=null,
        /** @var string|null */
        public ?string $archiveUrl=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $responseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['lang'])) $this->lang = JsonConverters::from('ProtocLang', $o['lang']);
        if (isset($o['generatedFiles'])) $this->generatedFiles = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['generatedFiles']);
        if (isset($o['archiveUrl'])) $this->archiveUrl = $o['archiveUrl'];
        if (isset($o['responseStatus'])) $this->responseStatus = JsonConverters::from('ResponseStatus', $o['responseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->lang)) $o['lang'] = JsonConverters::to('ProtocLang', $this->lang);
        if (isset($this->generatedFiles)) $o['generatedFiles'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->generatedFiles);
        if (isset($this->archiveUrl)) $o['archiveUrl'] = $this->archiveUrl;
        if (isset($this->responseStatus)) $o['responseStatus'] = JsonConverters::to('ResponseStatus', $this->responseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

class Protoc implements JsonSerializable
{
    public function __construct(
        /** @var ProtocLang|null */
        public ?ProtocLang $lang=null,
        /** @var array<string,string>|null */
        public ?array $files=null,
        /** @var string|null */
        public ?string $protoUrl=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['lang'])) $this->lang = JsonConverters::from('ProtocLang', $o['lang']);
        if (isset($o['files'])) $this->files = JsonConverters::from(JsonConverters::context('Dictionary',genericArgs:['string','string']), $o['files']);
        if (isset($o['protoUrl'])) $this->protoUrl = $o['protoUrl'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->lang)) $o['lang'] = JsonConverters::to('ProtocLang', $this->lang);
        if (isset($this->files)) $o['files'] = JsonConverters::to(JsonConverters::context('Dictionary',genericArgs:['string','string']), $this->files);
        if (isset($this->protoUrl)) $o['protoUrl'] = $this->protoUrl;
        return empty($o) ? new class(){} : $o;
    }
}

PHP Protoc DTOs

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

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	lang: cpp,
	files: 
	{
		String: String
	},
	protoUrl: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	lang: cpp,
	generatedFiles: 
	{
		String: String
	},
	archiveUrl: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}