You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@apisix.apache.org by JunXu Chen <ch...@apache.org> on 2020/12/07 08:23:29 UTC

Discuss: API doc format for Manager API

Hi, Community,

APISIX Dashboard Manager API has no api documentation, we need to add it
recently.

At present, it is more common to use swagger or markdown to write api
documents.

Swagger is easier to manage and extend, while markdown is more intuitive
and convenient, and can be displayed directly on github.

Which one do you prefer,  swagger or markdown?

Thanks.

Re: Discuss: API doc format for Manager API

Posted by Ming Wen <we...@apache.org>.
+1 for Swagger

Thanks,
Ming Wen, Apache APISIX PMC Chair
Twitter: _WenMing


Zhiyuan Ju <ju...@apache.org> 于2020年12月19日周六 上午9:26写道：

> fine, I see we have used the Swagger to generate docs in the project :)
>
> Best Regards!
> @ Zhiyuan Ju <https://www.shaoyaoju.org/>
>
>
> JunXu Chen <ch...@apache.org> 于2020年12月7日周一 下午4:23写道：
>
> > Hi, Community,
> >
> > APISIX Dashboard Manager API has no api documentation, we need to add it
> > recently.
> >
> > At present, it is more common to use swagger or markdown to write api
> > documents.
> >
> > Swagger is easier to manage and extend, while markdown is more intuitive
> > and convenient, and can be displayed directly on github.
> >
> > Which one do you prefer,  swagger or markdown?
> >
> > Thanks.
> >
>

Re: Discuss: API doc format for Manager API

Posted by Zhiyuan Ju <ju...@apache.org>.
fine, I see we have used the Swagger to generate docs in the project :)

Best Regards!
@ Zhiyuan Ju <https://www.shaoyaoju.org/>


JunXu Chen <ch...@apache.org> 于2020年12月7日周一 下午4:23写道：

> Hi, Community,
>
> APISIX Dashboard Manager API has no api documentation, we need to add it
> recently.
>
> At present, it is more common to use swagger or markdown to write api
> documents.
>
> Swagger is easier to manage and extend, while markdown is more intuitive
> and convenient, and can be displayed directly on github.
>
> Which one do you prefer,  swagger or markdown?
>
> Thanks.
>

Re: Discuss: API doc format for Manager API

Posted by YuanSheng Wang <me...@apache.org>.
+1 for Swagger too.

On Sat, Dec 19, 2020 at 1:21 PM Zhang Chao <zc...@gmail.com> wrote:

> +1 for Swagger.
>
> Chao Zhang
> https://github.com/tokers
>
> On December 7, 2020 at 4:23:43 PM, JunXu Chen (chenjunxu@apache.org)
> wrote:
>
> Hi, Community,
>
> APISIX Dashboard Manager API has no api documentation, we need to add it
> recently.
>
> At present, it is more common to use swagger or markdown to write api
> documents.
>
> Swagger is easier to manage and extend, while markdown is more intuitive
> and convenient, and can be displayed directly on github.
>
> Which one do you prefer, swagger or markdown?
>
> Thanks.
>


-- 

*MembPhis*
My GitHub: https://github.com/membphis
Apache APISIX: https://github.com/apache/apisix

Re: Discuss: API doc format for Manager API

Posted by Zhang Chao <zc...@gmail.com>.
+1 for Swagger.

Chao Zhang
https://github.com/tokers

On December 7, 2020 at 4:23:43 PM, JunXu Chen (chenjunxu@apache.org) wrote:

Hi, Community,

APISIX Dashboard Manager API has no api documentation, we need to add it
recently.

At present, it is more common to use swagger or markdown to write api
documents.

Swagger is easier to manage and extend, while markdown is more intuitive
and convenient, and can be displayed directly on github.

Which one do you prefer, swagger or markdown?

Thanks.