Installation

See what languages, containers, and frameworks we support. Keep an eye on this list as it evolves based on customer feedback and releases.

Create an Appear account

Contact us, and we will provide you with an admin account. You can then add team members and configure your organisation.

Get your API key

Open the side menu and click on 'Settings' to create and view API keys. These can be used to separate concerns. Note that API keys aren't used per environment, as these are handled via the introspector detecting the environment variables.

You may wish to store this as an environment variable.

APPEAR_API_KEY:your_api_key

Install the Appear package

Choose the installation method and follow the instructions:

Install the package to your system. Installation methods vary per implementation, but the below gives a general idea:

npm i @appear.sh/introspector

Is what you need not visible? Get in touch with us and we'll see what we can do!

Integrate Appear

Once the package is installed, import it using your chosen language or framework method. Below gives a general idea:

import * as Appear from '@appear.sh/introspector'

Appear.init({
  apiKey: 'your-api-key',
  environment: process.env.NODE_ENV,
})

What to expect

Now that you've installed and integrated Appear, you can run your development server and mock user interactions through your application. As this happens, your Appear account will begin being populated with your API catalog, API references, resource maps, and more.

Once Appear is in your production environment, your account will populate automatically when users interact with your product.

This will instantly provide you with: