Integrating Swashbuckle with DapperDox

[lockewritesdocs]

@heldersepu, I am writing an article for a technical communications blog documenting how I integrated Swashbuckle with DapperDox. I will submit a PR with the article, which I think could be helpful to Swashbuckle users that want to generate a swagger.json file that they can serve to a static site generator other than the Swagger UI. Let me know what you think.

[lockewritesdocs]

@heldersepu, I created a branch and tried to merge it into master, but permission was denied. Can you give me access to merge the branch and create a PR?

[heldersepu]

I'm not sure what exactly are you trying to do /?!?!
You don't need any permissions to submit a PR
And I do not have any more access than you do, I can NOT give or take permission to this project

[heldersepu]

I do not see a Swashbuckle fork on your profile:
https://github.com/lockewritesdocs

[lockewritesdocs]

Apologies! I goofed on my end. PR #1107 submitted.

[heldersepu]

no problem, we all do at some point!
Do you have a public URL for your project working with DapperDox ?

A lot of steps...
I'm wondering if we can detach a fork and start a project that uses DapperDox instead of Swagger-Ui ?!?
Which one do you like better?

[lockewritesdocs]

Unfortunately, the implementation is being used to create documentation for our support team, and the information is proprietary.

DapperDox is a new technology, but it provides the capability to include documentation beyond just the API reference. I think that capability is really important. Also, the creator is very responsive!

[heldersepu]

is there a live demo somewhere of DapperDox ?

[lockewritesdocs]

If you download the latest release, you can run the integrated demo.

[heldersepu]

Ok, I download it and I'm running it ...
I like what I see! the Swagger Petstore (in my eyes) it looks better than:
http://petstore.swagger.io/

But I'm not quite sure how we can integrate this into a Nuget package, it seems that download is its own server not just a UI for a swagger definition

[lockewritesdocs]

After I use Swashbuckle to create a swagger.json file, I run .\dapperdox --spec-dir=dir_with_swagger.json_file, and then point my browser at http://localhost:3123. That's it! What would we need beyond the executable?

[heldersepu]

O yeah I did get it running ...
My idea was to detach a fork from Swashbuckle and replace the SwaggerUi with DapperDox
But DapperDox is not just a UI that we can "easily" integrate

[heldersepu]

I think it will be nice if you would not need to create a file.
instead DapperDox should read directly from something like:
http://swashbuckletest.azurewebsites.net/swagger/docs/v1

[lockewritesdocs]

DapperDox is not creating the file. Swashbuckle (with some tweaking) creates a swagger.json file from the code source (like the one you linked to), which DapperDox consumes and displays in its UI.

Please let me know if I am misunderstanding your statement.

[heldersepu]

@lockewritesdocs
My idea is to not create any file!
Instead DapperDox should read, consumes and display directly from url (that will probably be a new feature)
Right now you run .\dapperdox --spec-dir=dir_with_swagger.json_file
It will be nice something like:
.\dapperdox --spec-url=http://swashbuckletest.azurewebsites.net/swagger/docs/v1

[lockewritesdocs]

@heldersepu, thank you for the explanation! I'm going to reach out to the DapperDox folks to see if a feature like that one is something that they are considering.