Page tree
Skip to end of metadata
Go to start of metadata

Summary: This document provides information about the extension providing ASP.NET Web API support for C#.

What's new?

See ASP.NET Web API - 1.0 - Release Notes for more information.

Description

This extension provides support for ASP.NET Web API. This extension will enable users to create links between server side APIs and client calls for HttpGet, httpPut, HttpPost, and HttpDelete methods.

In what situation should you install this extension?

If your .NET application contains ASP.NET Web API source code and you want to view these object types and their links with client side calls, then you should install this extension.

ASP.NET Web API support

The following frameworks are supported by this extension:

Version
Supported
Web API 2(tick)
ASP.NET Core Web API(tick)

Function Point, Quality and Sizing support

This extension provides the following support:

  • 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
Function Points
(transactions)
Quality and Sizing
(tick)(error)

CAST AIP compatibility

This extension is compatible with:

CAST AIP release
Supported
Languages
8.3.x(tick)C#
8.2.x(tick)C#
8.1.x(tick)C#
8.0.x(tick)C#
7.3.7 and all higher 7.3.x releases(tick)C#

Supported DBMS servers

This extension is compatible with the following DBMS servers:

DBMS

Supported

CSS/PostgreSQL(tick)
Oracle(tick)
Microsoft SQL Server

(error)

Prerequisites

(tick)An installation of any compatible release of CAST AIP (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 (i.e. by performing an Advanced onboarding) 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:

There is nothing further to do. Follow the instructions below to run a new analysis/snapshot to generate new results:

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.

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:

Objects

All objects are represented under the Class browser folders in CAST Enlighten:

IconDescription

.NET Get Operation

.NET Delete Operation

.NET Post Operation

.NET Put Operation
SourceLink typeTargetExample
Client callCall.NET Get Operation

Client callCall.NET Delete Operation

Client callCall.NET Post Operation

Client callCall.NET Put Operation

ASHX/ASMX support

WebHandle/ProcessRequest

In ashx/asmx file:

<%@ WebHandler Language="vb" CodeBehind="IISHandler1.vb" class="WebApplication1.IISHandler1" %>

In IISHandler1.vb:

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:

WebService/WebMethod

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:

Rules

None.

Limitations

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:
    • HttpGet
    • HttpPut
    • HttpDelete
    • HttpPost
  • Routing path with parameters is not supported
  • Only the controller derived from ApiController class will be processed for linking
  • Combination of Route annotation and Http[Post|Get|Put|Delete] annotations creates more links than expected
  • No labels