WCF服务文档

时间:2009-05-14 19:35:27

标签: wcf

在技术产品文档中记录/发布WCF服务信息的最佳方法是什么,程序员和非程序员都会关注?此外,什么是最好的出版工具。

3 个答案:

答案 0 :(得分:3)

充其量只是一个棘手的问题! : - )

您可以将WCF服务描述导出到WSDL文件并使用<xs:documentation><xs:annotation>元素进行丰富,然后使用XSLT转换将其转换为可读的HTML文档 - 但这不是很好真的很有用......

这是一个显示如何执行此操作的链接: http://andrewtokeley.net/archive/2008/10/30/adding-wsdl-documentation-to-your-wcf-services.aspx

其中一些XML工具还提供了记录WSDL文件的方法 - 通常也来自那些文档和注释标记 - 这里有一个例子:http://www.oxygenxml.com/doc/ug-oxygen/generate-wsdl-documentation.html

这是一个在线版本(以及可下载的XSLT转换),用于将文档和注释元素转换为WSDL:http://tomi.vanek.sk/index.php?page=wsdl-viewer

我在这里并没有真正的答案 - 但对这个话题也很感兴趣!

马克

答案 1 :(得分:1)

看一下这个问题:Best way to document a WCF interface

答案 2 :(得分:1)

使用help page创建WCF REST服务时会生成WCF REST Starter Kit。你似乎没有使用REST,但我想我会提到它,因为这种格式可能适合你。

这使用“操作说明”公开操作的Atom Feed。

这个样本出现了一点反思:

public Atom10FeedFormatter GetFeed(ContractDescription contractDescription)
{
    List<SyndicationItem> items = new List<SyndicationItem>();
    foreach (OperationDescription od in contractDescription.Description.Operations)
    {
        WebGetAttribute get = od.Behaviors.Find<WebGetAttribute>();
        WebInvokeAttribute invoke = od.Behaviors.Find<WebInvokeAttribute>();
        string method = this.GetMethod(get, invoke);
        string requestFormat = null;
        if (invoke != null)
        {
            requestFormat = this.GetRequestFormat(invoke, od);
        }
        string responseFormat = this.GetResponseFormat(get, invoke, od);
        string uriTemplate = this.GetUriTemplate(get, invoke, od);
        WebMessageBodyStyle bodyStyle = this.GetBodyStyle(get, invoke);
        string requestSchemaLink = null;
        string responseSchemaLink = null;
        string requestExampleLink = null;
        string responseExampleLink = null;
        if (bodyStyle == WebMessageBodyStyle.Bare)
        {
            UriTemplate responseSchemaTemplate = new UriTemplate("help/{operation}/response/schema");
            responseSchemaLink = responseSchemaTemplate.BindByPosition(this.BaseUri, new string[] { od.Name }).AbsoluteUri;
            UriTemplate responseExampleTemplate = new UriTemplate("help/{operation}/response/example");
            responseExampleLink = responseExampleTemplate.BindByPosition(this.BaseUri, new string[] { od.Name }).AbsoluteUri;
            if (invoke != null)
            {
                UriTemplate requestSchemaTemplate = new UriTemplate("help/{operation}/request/schema");
                requestSchemaLink = requestSchemaTemplate.BindByPosition(this.BaseUri, new string[] { od.Name }).AbsoluteUri;
                UriTemplate requestExampleTemplate = new UriTemplate("help/{operation}/request/example");
                requestExampleLink = requestExampleTemplate.BindByPosition(this.BaseUri, new string[] { od.Name }).AbsoluteUri;
            }
        }
        uriTemplate = HttpUtility.HtmlEncode(string.Format("{0}/{1}", this.BaseUri.AbsoluteUri, uriTemplate));
        string xhtmlDescription = string.Format("<div xmlns=\"http://www.w3.org/1999/xhtml\"><table border=\"5\"><tr><td>UriTemplate</td><td>{0}</td></tr><tr><td>Method</td><td>{1}</td></tr>", uriTemplate, method);
        if (!string.IsNullOrEmpty(requestFormat))
        {
            xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Request Format</td><td>{0}</td></tr>", requestFormat);
        }
        if (requestSchemaLink != null)
        {
            xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Request Schema</td><td><a href=\"{0}\">{0}</a></td></tr>", HttpUtility.HtmlEncode(requestSchemaLink));
        }
        if (requestExampleLink != null)
        {
            xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Request Example</td><td><a href=\"{0}\">{0}</a></td></tr>", HttpUtility.HtmlEncode(requestExampleLink));
        }
        xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Response Format</td><td>{0}</td></tr>", responseFormat);
        if (responseSchemaLink != null)
        {
            xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Response Schema</td><td><a href=\"{0}\">{0}</a></td></tr>", HttpUtility.HtmlEncode(responseSchemaLink));
        }
        if (responseExampleLink != null)
        {
            xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Response Example</td><td><a href=\"{0}\">{0}</a></td></tr>", HttpUtility.HtmlEncode(responseExampleLink));
        }
        WebHelpAttribute help = od.Behaviors.Find<WebHelpAttribute>();
        if ((help != null) && !string.IsNullOrEmpty(help.Comment))
        {
            xhtmlDescription = xhtmlDescription + string.Format("<tr><td>Description</td><td>{0}</td></tr>", help.Comment);
        }
        xhtmlDescription = xhtmlDescription + "</table></div>";
        var item = new SyndicationItem() {
           Id = "http://tmpuri.org/" + od.Name,
           Content = new TextSyndicationContent(xhtmlDescription, TextSyndicationContentKind.XHtml),
           LastUpdatedTime = DateTime.UtcNow,
           Title = new TextSyndicationContent(string.Format("{0}: {1}", this.Description.Name, od.Name))
        };
        items.Add(item);
    }
    SyndicationFeed feed = new SyndicationFeed()
    {
       Title = new TextSyndicationContent("Service help page"),
       LastUpdatedTime = DateTime.UtcNow,
       Items = items
    };
    WebOperationContext.Current.OutgoingResponse.ContentType = "application/atom+xml";
    return feed.GetAtom10Formatter();
}