ARC Documentation
Install ARCGitHub projectTwitter
  • Getting started
  • Installation
  • Moving From Chrome Application To Desktop Client
  • Privacy
  • Using ARC
    • Sending requests
      • Body editor
      • Authorizing a request
      • Request editor options
    • Environments and variables
    • Host rules
    • Request actions
    • Cookies and session management
    • Workspaces
    • HTTP Requests History
    • Saved requests
    • ARC (legacy) projects
    • Searching for requests
    • Automated API documentation
    • HTTP Proxy
    • Frequently asked questions
    • Application auto update
  • Guides
    • Authenticating With OAuth2 And Request Actions
  • API School
    • Web APIs basics
    • RESTful APIs getting started
  • ARC Actions
    • Introduction
      • Set variable action
      • Set cookie action
      • Remove cookie(s) action
  • ARC development
    • Git branches
    • Architecture
Powered by GitBook
On this page

Was this helpful?

  1. Using ARC

Automated API documentation

This document describes how to read API specification (RAML and OAS) to render automated documentation of the API.

PreviousSearching for requestsNextHTTP Proxy

Last updated 3 years ago

Was this helpful?

This documentation is for ARC version 16 and up.

Advanced REST Client has embedded its sister project developed by MuleSoft: API Console. It is an API documentation tool that generates API documentation from the API model. You can learn more about API Console at .

After opening an API specification you can choose to store the API in the internal database for future use. From the REST APIs menu, you can load previously saved API.

API Console has a different user interface compared to ARC's normal view. It focuses on the documentation part. From here you can learn how the API work but also consume the API through the "Try it" panel. In this editor, the request editor is pre-configured to ask for the request parameters required for the successful connection. Because the parameters are described in the API specification the request editor knows what kind of data to expect. This helps you to faster build the HTTP request and see the result.

You can choose the Explore option from the context menu to find APIs in Anypoint Exchange. It is an API catalog created by MuleSoft. If you have an account and you use our design tools, you can log in to your account to list your private assets.

When you click on the Download button the API specification is downloaded from Anypoint Exchange and processed by ARC to generate the graph model the API Console uses to generate the view.

api-console.io
REST APIs list in Advanced REST Client
Generated documentation in API Console
REST APIs context menu