Installation

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

You can integrate with Appear in three key ways right now.

1. SDKs

2. API endpoint (docs coming soon)

3. OTel integration (docs coming soon)

For the majority of users, the SDK approach is the most expedient. Below gives an outline of how to install Appear's introspector agent SDK.

---

SDK installation overview

1

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.

2

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

3

Install the Appear package

Choose the installation method and follow the instructions:

• Javascript/Typescript

• NextJS

• Redwood JS & Vercel

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!

4

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:

• API references

• API catalog

• Visual resource map

• Responses

• Scenarios

• Plus loads more

---

Language/framework implementations status

Appear's introspection agent currently works with HTTP/REST APIs with the following.

Framework	SDK status	API Endpoint status	OTel integration status
NestJS
NextJS
Node.js
Kotlin
PHP
.Net
Ruby
Go
Kubernetes Sidecar
ECS Ssidecar

Missing what you need to get started with Appear? Request support and we would love to discuss how we can help you.

Unsupported

At this stage, we don't have concrete plans to support the following:

• GraphQL

• gRPC

• Async APIs

---

If you have any queries or require support with the above instructions, please get in touch with us.