当前位置:  开发笔记 > 前端 > 正文

从WCF服务生成RESTful API文档

如何解决《从WCF服务生成RESTfulAPI文档》经验,为你挑选了1个好方法。

我最近开始了一个在WCF中构建RESTful API的项目,我将需要公开文档以及API本身.我希望利用我的文档中的XML代码注释来获取本文档.

但我想要输出的只是服务公开的合同:端点和JSON/XML对象结构.因为我正在尝试创建外部文档,所以我对我的库中的任何内部感兴趣,或者它如何与.Net框架(或者甚至是.Net,就此而言)联系起来.

我可以选择哪些工具来创建这些文档?我听说Sandcastle或Doxygen是从XML代码注释生成文档的好工具,但是我可以过滤掉我不想公开的类和方法吗?



1> Rick Glos..:

我理解这个问题是在.NET 4.0之前提出的,但是从.NET 4.0开始,您可以按照WCF Web HTTP服务帮助页面中的描述创建"帮助页面" .

WCF 4.0示例

[System.ComponentModel.Description("Triggers Method Name Behavior.")]
public void MethodName() {}

推荐阅读
360691894_8a5c48
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有