ProtocApi

<back to all web services

Protoc

The following routes are available for this service:
All Verbs/protoc/{Lang}
Protoc Parameters:
NameParameterData TypeRequiredDescription
LangpathLangNo
FilesqueryDictionary<string, string>No
ProtoUrlquerystringNo
Lang Enum:
NameValue
Cppcpp
CSharpcsharp
Dartdart
Javajava
JavaLitejava-lite
ObjectiveCobjc
Phpphp
Pythonpython
Rubyruby
Gogo
JavaScriptClosurejs-closure
JavaScriptCommonJsjs-commonjs
JavaScriptNodeJsjs-node
Swiftswift
TypeScriptts
TypeScriptBinaryts-binary
ProtocResponse Parameters:
NameParameterData TypeRequiredDescription
LangformLangNo
GeneratedFilesformDictionary<string, string>No
ArchiveUrlformstringNo
ResponseStatusformResponseStatusNo

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