SigSpec UI #35
SigSpec UI #35
Conversation
|
@RicoSuter Would you be able to take a quick look at this, I have started to work on the SigSpecUI, just wanted to make sure i am heading down the correct track with this? If you read the comments above you can see a list of Features that are currently implemented. If you run the UI project you will also need to run the HelloSignalR example as that's where it gets the spec from, in time this will work as Middleware. |
|
Lgtm I see the following tasks:
What do you think? Very nice btw, i personally dont use SignalR much, so wont be able to contribute much. |
…s' into feature/sigspec-ui # Conflicts: # src/SigSpec.AspNetCore/Extensions/SigSpecApplicationBuilderExtensions.cs # src/SigSpec.AspNetCore/SigSpec.AspNetCore.csproj # src/SigSpec.AspNetCore/SigSpecSettings.cs
# Conflicts: # src/SigSpec.AspNetCore/Extensions/SigSpecApplicationBuilderExtensions.cs # src/SigSpec.AspNetCore/SigSpecSettings.cs # src/SigSpec.AspNetCore/SigSpecUi/index.html # src/SigSpec.AspNetCore/SigSpecUiSettings.cs
|
Btw, i’m not saying nswag is the way we should do it - there are many things which i would do differently internally but i dont have the tike to change it.. at least we should make the api as similar as possible.. please tell me if something doesnt make sense or could be simplified.. I’ve added some tasks to the issue, but we can also move them to separate gh issues.. |
|
Cool thanks for taking a look i am hoping to get some more time to work on adding the features you mentioned such as injecting the settings into the html, and adding support for a JWT token. as the app i am working on requires one for the SignalR. I haven't really looked at the NSwag code much so dont know if there is anything we need to do differently for this project, |
| namespace SigSpec.AspNetCore.Middlewares | ||
| using Microsoft.AspNetCore.Http; | ||
|
|
||
| namespace SigSpec.AspNetCore.Middlewares | ||
| { | ||
| public class SigSpecSettings | ||
| { | ||
| /// <summary>Gets or sets the path to serve the SigSpec document (default: '/sigspec/{documentName}/sigspec.json').</summary> | ||
| public string Path { get; set; } = "/sigspec/{documentName}/sigspec.json"; |
There was a problem hiding this comment.
Rename to Route? What is the default in asp?
|
Is there any update on this? |
|
Hey sorry, I have been busy with work, i will try resolve the code review comments today and add the authentication, then maybe it could be ready for an alpha release? |
|
@RicoSuter @TomSmith27 any news on this? |
|
I am still planning to work on it, all that needs implementing now is a way to provide a token like normal swagger so will try and do that this week |
What do you mean with that? Authentication? |
The Start of a UI for SigSpec similar to swagger UI
Closes #7
Will fetch the SigSpec json from 'sigspsec/spec.json' and render a UI based on the data.
Features
Hubs
Each hub will try and connect on page load and display an indicator to show whether this was successful
Callbacks
This is an example of a callback, it allows you to start and stop listening to a callback, and while listening any incoming messages will appear in the black box with the timestamp and the parameters of the message.
Operations
Operations work very much like post requests in SwaggerUI and will allow to fill in the method parameters this can be either primitive types or objects
Definitions
This works the same as SwaggerUI
Open tasks