2

在下面的给定示例代码中，元数据页面永远不会获得中指定的描述

[Description("GET account, all or by list of groups or by list of logins")]

是否需要设置特殊配置才能在元数据页面中显示描述？

代码：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.ComponentModel;
using ServiceStack.ServiceHost;
using System.Runtime.Serialization;
using ServiceStack.WebHost.Endpoints;

namespace ConsoleApplication2
{
    public class User
    {
        public User()
        {

        }
        public int login;
        public string group;
        public string name;
    }

    [Description("GET account, all or by list of groups or by list of logins")]
    [Route("/accounts")]
    public class Accounts : IReturn<List<User>>
    {
        public string[] groups { set; get; }
        public int[] logins { set; get; }

        public Accounts() { }

        public Accounts(params int[] logins)
        {
            this.logins = logins;
        }

        public Accounts(params string[] groups)
        {
            this.groups = groups;
        }
    }

    public class Host : AppHostHttpListenerBase
    {
        public Host() : base("Test", 
                            typeof(Accounts).Assembly)
        {

        }

        public override void Configure(Funq.Container container)
        {
            SetConfig(new EndpointHostConfig { 
                EnableFeatures = Feature.All

            });
        }
    }

    public class Servce : IService
    {
        public object Get(Accounts request)
        {
            return new List<User>(){new User()};
        }

    }

    class Program
    {
        static void Main(string[] args)
        {
            var host = new Host();
            host.Init();
            host.Start("http://+:12345/");

            Console.ReadLine();

        }
    }
}

导航到http://localhost:12345/json/metadata?op=Accounts生产

<body>
    <a id="logo" href="http://www.servicestack.net" title="servicestack"></a>
    <h1>Test</h1>

    <form>
    <div>
        <p><a href="/metadata">&lt;back to all web services</a></p>
        <h2>Accounts</h2>



        <div class="example">
        <!-- REST Examples -->
        ...
4

1 回答 1

4

在最近发布的 ServiceStack中，[Description]已弃用，[Api]而在ServiceStack 的 Swagger 支持[ApiMember]中也使用了它。

现在这是一个完全注释服务的示例：

[Api("Service Description")]
[Route("/swagger/{Name}", "GET", Summary = @"GET Summary", Notes = "GET Notes")]
[Route("/swagger/{Name}", "POST", Summary = @"POST Summary", Notes = "POST Notes")]
public class MyRequestDto
{
    [ApiMember(Name="Name", Description = "Name Description", 
               ParameterType = "path", DataType = "string", IsRequired = true)]
    public string Name { get; set; }
}
于 2013-02-12T05:01:05.797 回答