WebAPI Pages d'Aide: désactiver pour le lancement de la Production

J'ai développé un certain nombre de l'intérieur RESTE interfaces à l'aide de l'ancienne WCF cadre dans VS 2010. La possibilité pour elle de générer des pages d'aide est à portée de main pour développement et d'assurance qualité des plates-formes, mais pour une version de production, il était facile de désactiver la génération de ces pages d'aide dans la web.config fichier:

<standardEndpoint name="" helpEnabled="false" automaticFormatSelectionEnabled="true"/>

Je suis maintenant sur l'utilisation de la WebAPI cadre à la place (actuellement la version 1 sur VS 2012), mais il ne semble pas être aussi trivial pour désactiver cette fonction (c'est à dire que je peux pas trouver toutes les informations sur la façon de le faire dans un site web.fichier de config).

Certainement je peux aller de l'avant et le faire à la main dans le code lui-même, mais il y a certainement un moyen plus facile; quelque chose de similaire à la façon dont WCF fait comme décrit ci-dessus. Je voudrais utiliser le web.fichier de configuration de l'approche puisque j'ai déjà le web.la libération.config de transformer les fichiers en place pour les autres paramètres.

Des idées sur les meilleures pratiques sur ce serait appréciée.

OriginalL'auteur GoodEnuf | 2014-06-11

asp.net-web-api asp.net-web-api-helppages c#rest

6

API Web ne possède pas de support de la boîte à l'égard de web.config en fonction de l'activation ou de la désactivation de l'helppage.

Quelques options que vous pouvez envisager:
- Depuis HelpPage est installé comme un MVC région, lors du déploiement de
  de production, vous pourriez juste exclure cette HelpPage dossier.
- Créer une action de filtre qui renvoie 404 comme suggéré ici: Conditionnellement désactiver ASP.NET Contrôleur MVC
REMARQUE: pour le cas ci-dessus, si vous utilisez la valeur par défaut de l'API Web modèle, alors oui vous auriez besoin d'une étape supplémentaire pour afficher/ne pas afficher le Help lien dans la barre de navigation.

Oui, c'est ce qu'il semble être. Dans ce cas, je suis en utilisant le modèle par défaut, mais je ne pense pas que ça va être beaucoup de travail pour obtenir autour de cette. Je peux certainement mettre un indicateur dans le web.le fichier config pour mon propre usage dans le code, ou peut-être l'ajout d'un COMMUNIQUÉ de directive de préprocesseur et utiliser un bon ol' #si #endif pour bloquer le code...
Je viens de supprimer le dossier des zones. Swagger API est beaucoup plus agréable que celui par défaut, de toute façon.

OriginalL'auteur Kiran Challa
5

Ouvrir le Global.asax.cs,modifier votre code, comme l'extrait de code suivant code:
```
#if DEBUG
   AreaRegistration.RegisterAllAreas();
#endif
```
Parce que la page d'aide est dans la Zone nommée "HelpPage", de sorte que nous ne pouvons l'ignorer par le code ci-dessus dans la libération ou de l'environnement de production.

Ce n'est pas en soi une solution sécurisée.Si vous entrez l'url dans le navigateur, vous obtenez une exception non gérée complet avec trace de la pile et des informations de version pour les deux .NET Framework et ASP.NET

OriginalL'auteur Farb
3

Vous pouvez utiliser la directive #if DEBUG pour cacher votre code dans realase

Indicateur de DÉBOGAGE n'est d'aucune utilité dans la plupart des cas, parce que la mise en scène et\ou de l'environnement de test exécuter sans DÉBOGAGE.

OriginalL'auteur jarek
1

Au cas où quelqu'un tombe sur cette question, voici comment j'ai réussi à le faire.

J'ai ajouté de l'application suivante de réglage à la base du Web.fichier de configuration:
```
<add key="ExcludeHelpPage" value="false" />
```
J'ai ensuite transformé cette valeur dans ma vie ou la LIBÉRATION fichier de config comme ceci:
```
<add key="ExcludeHelpPage" value="true" xdt:Transform="Replace" xdt:Locator="Match(key)"  />
```
Puis j'ai ajouté le code suivant à la fin de mon WebApiConfig.Méthode Register:
```
if (Convert.ToBoolean(System.Configuration.ConfigurationManager.AppSettings["ExcludeHelpPage"]))
{
    config.Routes.IgnoreRoute("help", "help");
}
```
Cela fera l'aide de la page indisponible pour des configs avec ExcludeHelpPage définie sur true.

Votre idée me semble vraiment grand, mais il ne fonctionne pas pour moi. Sur mon Registre, j'ai ce config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{id}", defaults: new { id = RouteParameter.Optional } );et j'ai ajouter votre code après. Mais sur le "HelpPageAreaRegistration.cs" j'ai new { controller = "Help", action = "Index", apiId = UrlParameter.Optional }); Aucune idée de pourquoi l'aide n'est pas d'être ignoré?

OriginalL'auteur Soeholm

Ma solution pour la désactivation de ApiController contrôleur:

Utilise WebConfig AppSettings config drapeau au lieu de (#if DEBUG)
Avant la méthode est invoquée ExecuteAsync intercepte l'invocation et vérifie fonction bascule (drapeau);
si cette fonction est désactivée, les retours HTTP 410 GONE
Si c'est commun à de nombreux contrôleurs, déplacer le code du contrôleur de la classe de base

Le code:

public class TestController : ApiController
{
    public override Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken)
    {
        var featureFlag = Convert.ToBoolean(System.Configuration.ConfigurationManager.AppSettings["EnableTest"]);

        if (featureFlag == false)
        {
            return Task.FromResult(new HttpResponseMessage(HttpStatusCode.Gone));
        }

        return base.ExecuteAsync(controllerContext, cancellationToken);
    }

OriginalL'auteur andrew.fox

Vous devez vous connecter pour publier un commentaire.