Auto Docs for UD Rest Api

#1

I’m playing with the idea of auto generate docs for APIs that created using New-UDEndoint for the Start-UDRestApi.

This is how i should look at the end.

Do you think it should be an external module or inside the main UD module ?

1 Like
#2

I would do an external module unless it’s an integral part of UD. That said, I love this idea!

#3

I would much more prefer swagger UI.

#4

Ud current do not support auto generated configuration files for swagger , so if im not mistaken you need to write yaml or json config file yourself?

#5

would it not be easyer to make the module do the openAPI manifest? (swagger file)
and then just incorporate swagger ui?

#6

I talked to adam about this, we still thinking about it

#7

it could be that we would need to define some more metadata on the endpoint cmdlet.

#8

and implement NSwag into the ud endpoint service

#9

UniversalDashboard + Swagger , step 1 complete .

3 Likes
#10

Wow, how cool is that!

#11

Very nice @AlonGvili !

#12

You need some more Chrome extensions, @AlonGvili ! Also, that looks great.