> For the complete documentation index, see [llms.txt](https://knowledgebase.autorabit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-analyzer/source-code-analysis/api-analysis.md).

# API Analysis

### Overview

In an API and micro services world, quality of the deliverable becomes paramount – since a weak link can break the whole chain.

Now with API Analyzer plugin, APIs can be quality tested in an automated manner. Make sure that only the quality integration without security issues/vulnerability will make it through the quality gate. API Analyzer plugin supports scanning multiple APIs within the same project. Supported versions include:

* RAML 0.8
* RAML 1.0
* OAS / Swagger 2.0
* OAS 3.0

### Analyzing or Scanning APIs

API projects can be scanned for issues using any of the following approaches:

1. Anypoint Studio plugin - Get the results in real time as when the APIs are being developed.
2. Sonar Scanner - API projects can be scanned using sonar scanner to view the scan results in web dashboard.

### Choosing between multiple APIs

If a project contains multiple APIs, all the available APIs will be scanned. There might be certain scenarios where you need to scan specific APIs instead of all. Specific APIs can be included or excluded by using **`analyzer-apis.json`** file. Create a file called **`analyzer-apis.json`** in the project root directory and specify the required APIs to be scanned.

In the example below, only api\_1.raml and api\_2.raml will be considered during analysis.

```json
{
  "apis": [
    "relative/path/to/api_1.raml",
    "relative/path/to/api_2.raml"
  ]
}
```

### See Also

* [Code Analysis In Server](/product-guides/integral-zone/iz-analyzer/manage-server-plugin/install-server-plugin.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://knowledgebase.autorabit.com/product-guides/integral-zone/iz-analyzer/source-code-analysis/api-analysis.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.