nodebb-plugin-minecraft-integration icon indicating copy to clipboard operation
nodebb-plugin-minecraft-integration copied to clipboard

Published 20 hours ago • verified publisher icon yariplus

Add API Documentation

Open popey456963 opened this issue 8 years ago • 4 comments

The URL appears to lead to a non-existent address.

  • https://github.com/yariplus/nodebb-plugin-minecraft-integration/wiki/API

popey456963 avatar Jul 11 '16 23:07 popey456963

Eh, I fixed the link, but the page is old anyway.

I should be able to setup some automatic document generation for API.

yariplus avatar Jul 11 '16 23:07 yariplus

If I may suggest Swagger. I've used it a couple of times and it does generate the most fabulous API Docs around, the live "test it out" examples really make it. You'd need an actual website though, I don't think it's compatible particularly well with Github Wiki.

popey456963 avatar Jul 12 '16 09:07 popey456963

@yariplus I would recommend API Blueprint, because it renders into Markdown which you can just host on GitHub AFAIK

lenovouser avatar Jul 12 '16 12:07 lenovouser

I'm leaning toward Swagger, but either one looks great.

yariplus avatar Jul 12 '16 23:07 yariplus