2

私は次のようなアクションメソッドを持っています

public JsonResult Index(string version)
{
   .. do stuff, return some data v1 or v2. Default = v2.
}

したがって、このアクションメソッドはいくつかのデータを返します。これらのデータは、またはのいずれかでフォーマットできますVersion 1（Version 2出力が何であれ...それらがスキーマ的に異なることを知っているだけです）。

したがって、ユーザーがこのリソースへのアクセスを呼び出したい場合、次のようになります。

http://www.blah.com/api/Index

難しいことは何もありません。

彼らもこれを行うことができます...

http://www.blah.com/api/Index?version=1.0

しかし、ユーザーがクエリ文字列パラメータを使用できるようにすることは可能ですversionか？v

eg. http://www.blah.com/api/Index?v=1.0

これにより、ActionMethodのバージョンパラメータが設定されます。可能？

4

3 に答える 3

3

アクションフィルターを使用してアクションメソッドパラメーターを操作できると思います。

基本的には、コレクション内の「v」をチェックし、QueryString存在する場合はコレクションにスローしActionParametersます。

public override void OnActionExecuting(ActionExecutingContext filterContext)
{
    var version = filterContext.HttpContext.Request.QueryString["v"];
    if (!string.IsNullOrEmpty(version))
        filterContext.ActionParameters["version"] = version;
}

HTH、
チャールズ

編集：それをもう少し一般的にする...

public class QueryStringToActionParamAttribute : ActionFilterAttribute
{
    private string _queryStringName;
    private string _actionParamName;

    public QueryStringToActionParamAttribute(string queryStringName, string actionParamName)
    {
        _queryStringName = queryStringName;
        _actionParamName = actionParamName;
    }

    public override void OnActionExecuting(ActionExecutedContext filterContext)
    {
        var queryStringValue = filterContext.HttpContext.Request.QueryString[_queryStringName];
        if (!string.IsNullOrEmpty(queryStringValue))
        {
            filterContext.ActionParameters[_actionParamName] = queryStringValue;
        }
    }
}

次に、次のように呼び出すことができます。

[QueryStringToActionParam("v", "version")];
于 2010-02-23T00:57:09.047 に答える
0

APIのバージョン管理を処理する別の方法は、APIバージョンごとに実際に異なるバージョンのコントローラーを用意することです。これにより、各アクションメソッドのすべてのバージョン番号をすべてチェックする必要がなくなります。各コントローラーは、APIの1つのバージョンにのみ適用できます。

私にとってのそのクリーナー（IMO）は、アクション時間ではなくルート時間でバージョン管理を処理します。ルーティング制約を使用してこれを実行し、バージョン番号を確認できます。

以下の例では、コントローラーV10およびV20は、ルート制約が通過した場合にのみルーティングできます。つまり、ヘッダーが存在し、ヘッダーがデフォルト（v2）でない場合にのみルーティングできます。

routes.MapRoute(
            "EmployeeListingv1",
            "employees",
            new { controller = "V10Employees", action = "Index" },  // Parameter defaults
            new { ApiV = new ApiVersionConstraint(ApiVersion.Version10) }
    );

routes.MapRoute(
                "EmployeeListingv2",
                "employees",
                new { controller = "V20Employees", action = "Index" },  // Parameter defaults
                new { ApiV = new ApiVersionConstraint(ApiVersion.Version20) }
        );

クエリ文字列を使用して、現在行っているようにバージョンを渡し、ルート制約に変更することもできますが、リクエストでオプションのヘッダーを使用すると、保守が簡単になることがわかりました。（それはまた、その全体の議論に入ることなく、より「RESTful」です。）ヘッダーがないということは、APIのデフォルト（最新）バージョンを意味します。

サンプルAPIバージョン制約：

/// <summary>
/// Enable routing of requests to controllers based on the 
/// API version contained in the header.
/// </summary>
public class ApiVersionConstraint : IRouteConstraint   
{
    const string VersionHeader = "X-MY-API-NAME-HERE-VERSION";

    private ApiVersion _version = ApiVersion.Unsupported;

    public ApiVersionConstraint(ApiVersion version)
    {
        this._version = version;
    }

    #region IRouteConstraint Members

    public bool Match(HttpContextBase httpContext, Route route, string parameterName, RouteValueDictionary values, RouteDirection routeDirection)
    {
        string vers = string.Empty;

        if (httpContext.Request.Headers[VersionHeader] != null)
        {
            vers = httpContext.Request.Headers[VersionHeader];
        }
        else
        {
            vers = "2.0"; // set default here.
        }

        ApiVersion fromHeader = ApiVersion.Unsupported;

        switch (vers)
        {
            case "1.0":
                {
                    fromHeader = ApiVersion.Version10;
                    break;
                }
            case "2.0":
                {
                    fromHeader = ApiVersion.Version20;
                    break;
                }

            default:
                {
                    fromHeader = ApiVersion.Unsupported;
                    break;
                }
        }

        return fromHeader == _version;

    }

    #endregion
}
于 2010-02-23T02:32:41.850 に答える
0

この古い質問にさらに何かを追加するだけです...ここでテクニックを組み合わせることができるので、@ Rosstifiedの回答のチェックを変更してQueryStringチェックを含めることにより、リクエストヘッダーまたはクエリ文字列によるバージョン選択をサポートできます。

        if (httpContext.Request.Headers[VersionHeader] != null) {
            vers = httpContext.Request.Headers[VersionHeader];
        } else {
            if (httpContext.Request.QueryString["v"] != null) {
                vers = httpContext.Request.QueryString["v"];
            } else {
                vers = "1.0"; // set default here.
            }
        }
于 2015-01-23T08:36:06.817 に答える