SigSpec for SignalR Core
Experimental API endpoint specification and code generator for SignalR Core.
Run SigSpec.Console to see a demo spec and the generated TypeScript code.
Please let me know what you think here.
Based on NJsonSchema (see also: NSwag).
Original idea: RicoSuter/NSwag#691
Sample
Hub:
public class ChatHub : Hub<IChatClient>
{
public Task Send(string message)
{
if (message == string.Empty)
{
return Clients.All.Welcome();
}
return Clients.All.Send(message);
}
public Task AddPerson(Person person)
{
return Task.CompletedTask;
}
public ChannelReader<Event> GetEvents()
{
var channel = Channel.CreateUnbounded<Event>();
return channel.Reader;
}
}
public class Event
{
public string Type { get; set; }
}
public class Person
{
[JsonProperty("firstName")]
public string FirstName { get; set; }
[JsonProperty("lastName")]
public string LastName { get; set; }
}
public interface IChatClient
{
Task Welcome();
Task Send(string message);
}Generated spec:
{
"hubs": {
"chat": {
"name": "Chat",
"description": "",
"operations": {
"Send": {
"description": "",
"parameters": {
"message": {
"type": [
"null",
"string"
],
"description": ""
}
}
},
"AddPerson": {
"description": "",
"parameters": {
"person": {
"description": "",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Person"
}
]
}
}
},
"GetEvents": {
"description": "",
"parameters": {},
"returntype": {
"description": "",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/Event"
}
]
},
"type": "Observable"
}
},
"callbacks": {
"Welcome": {
"description": "",
"parameters": {}
},
"Send": {
"description": "",
"parameters": {
"message": {
"type": [
"null",
"string"
],
"description": ""
}
}
}
}
}
},
"definitions": {
"Person": {
"type": "object",
"additionalProperties": false,
"properties": {
"firstName": {
"type": [
"null",
"string"
]
},
"lastName": {
"type": [
"null",
"string"
]
}
}
},
"Event": {
"type": "object",
"additionalProperties": false,
"properties": {
"Type": {
"type": [
"null",
"string"
]
}
}
}
}
}Generated TypeScript code:
import { HubConnection, IStreamResult } from "@aspnet/signalr"
export class ChatHub {
constructor(private connection: HubConnection) {
}
send(message: string): Promise<void> {
return this.connection.invoke('Send', message);
}
addPerson(person: Person): Promise<void> {
return this.connection.invoke('AddPerson', person);
}
getEvents(): IStreamResult<Event> {
return this.connection.stream('GetEvents');
}
registerCallbacks(implementation: IChatHubCallbacks) {
this.connection.on('Welcome', () => implementation.welcome());
this.connection.on('Send', (message) => implementation.send(message));
}
unregisterCallbacks(implementation: IChatHubCallbacks) {
this.connection.off('Welcome', () => implementation.welcome());
this.connection.off('Send', (message) => implementation.send(message));
}
}
export interface IChatHubCallbacks {
welcome(): void;
send(message: string): void;
}
export interface Person {
firstName: string;
lastName: string;
}
export interface Event {
Type: string;
}Development
Release new version
- Update versions with dnt bump-versions patch
- Commit to "master" (via PR)
- Merge into "release" to start nuget.org publish (via PR)