Summary: This document provides information about the extension providing ASP.NET Web API support for C#.
See: ASP.NET Web API Framework and Security Rules - 1.3 - Release Notes for more information.
This extension provides support for ASP.NET Web API. This extension will create links between server side APIs and client calls for HttpGet, httpPut, HttpPost, and HttpDelete methods.
In what situation should you install this extension?
CAST recommends that this extension is installed whenever you are analyzing a .NET application. When using CAST AIP Console, the extension is automatically installed whenever a .NET application is delivered.
ASP.NET Web API support
The following frameworks are supported by this extension:
|Web API 2|
|ASP.NET Core Web API|
|ASHX / ASMX (see below)|
- Function Points (transactions): a green tick indicates that OMG Function Point counting and Transaction Risk Index are supported
- Quality and Sizing: a green tick indicates that CAST can measure size and that a minimum set of Quality Rules exist
|Quality and Sizing|
CAST AIP release
Supported DBMS servers
This extension is compatible with the following DBMS servers:
|An installation of any compatible release of AIP Core (see table above)|
Download and installation instructions
A specific version of the ASP.NET Web API Framework extension is shipped with AIP Core. However, this release may not be the release you want to use, therefore you should check before beginning the analysis that the correct extension release is being used. You can see the list of shipped extensions for each release of AIP Core here: Technology coverage changes in CAST AIP 8.3.x.
If you need to change the release use the Included interface in AIP Console:
CAST Transaction Configuration Center (TCC) configuration
If you are using the extension with CAST AIP ≥ 8.3.x, a set of ASP.NET WebAPI specific items are now automatically imported when the extension is installed. These items will be available in the CAST Transaction Configuration Center (click to enlarge):
Packaging, delivering and analyzing your source code
Once the extension is installed, no further configuration changes are required before you can package your source code and run an analysis. The process of packaging, delivering and analyzing your source code does not change in any way:
- Package and deliver your .NET application (that includes source code which uses ASP.NET Web API) in the exact same way as you always have.
- Analyze your delivered .NET application source code in the CAST Management Studio in the exact same way as you always have - the source code which uses ASP.NET Web API will be detected and handled correctly.
Therefore you need to update TCC configuration if you are using the "Standard Entry Point - HTML5 AspDotNet" configuration in your sets and layers.
What results can you expect?
Once the analysis/snapshot generation has completed, you can view the results in the normal manner. The following objects and links will be displayed in CAST Enlighten:
All objects are represented under the Class browser folders in CAST Enlighten:
|.NET Get Operation|
|.NET Delete Operation|
|.NET Post Operation|
|.NET Put Operation|
|Client call||Call||.NET Get Operation|
|Client call||Call||.NET Delete Operation|
|Client call||Call||.NET Post Operation|
|Client call||Call||.NET Put Operation|
In ashx/asmx file:
<%@ WebHandler Language="vb" CodeBehind="IISHandler1.vb" class="WebApplication1.IISHandler1" %>
Imports System.Web Public Class IISHandler1 Implements IHttpHandler Public Sub ProcessRequest(ByVal context As HttpContext) Implements IHttpHandler.ProcessRequest ' Write your handler implementation here. End Sub End Class
Will create an operation:
In asmx file:
<%@ WebService Language="vb" CodeBehind="WebService1.asmx.vb" class="WebApplication1.WebService1" %>
In vb file:
Imports System.Web.Services Imports System.Web.Services.Protocols Imports System.ComponentModel ' To allow this Web Service to be called from script, using ASP.NET AJAX, uncomment the following line. ' <System.Web.Script.Services.ScriptService()> _ <System.Web.Services.WebService(Namespace:="http://tempuri.org/")> _ <System.Web.Services.WebServiceBinding(ConformsTo:=WsiProfiles.BasicProfile1_1)> _ <ToolboxItem(False)> _ Public Class WebService1 Inherits System.Web.Services.WebService <WebMethod()> _ Public Function HelloWorld() As String Return "Hello World" End Function End Class
Will create an operation for each WebMethod annotated methods:
In this section we list the most significant functional limitations that may affect the analysis of applications using ASP.NET Web API:
- Currently support only exists for the following objects:
- URL parameters on HttpPost operation not detected
- RoutingPath with parameters in the middle instead of end not supported
- Combination of Route annotation and Http[Post|Get|Put|Delete] annotations creates more links than expected