Appear docs
HomepageGitHubAPI toolkitSign inGet demo
  • Getting Started
    • Welcome to Appear
    • How Appear works
    • Who is Appear for?
    • Get In Touch
    • Installation
  • Installation
    • Javascript / Typescript
    • Framework specific installations
      • NestJS
      • NextJS
      • Custom integrations
  • Explanations
    • Branches and environments
  • Connections
  • Managing your APIs
    • Creating a service
    • Add service via URL
    • Grouping & filtering
    • Editing your APIs
    • Overriding/updating a service
  • OpenAPI spec version
  • Tagging services
  • Service Resources
    • Resource map
  • Managing your organisation
    • Managing team members
    • Adding verified domains
  • Resources
    • FAQs
    • Product Map
    • Open-source
Powered by GitBook
On this page
  • What to expect
  • Language/framework implementations
  • Unsupported

Was this helpful?

  1. Getting Started

Installation

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

PreviousGet In TouchNextJavascript / Typescript

Last updated 19 days ago

Was this helpful?

1

Create an Appear account

, 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:

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? 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

Check out our public to see what we have planned and what's in progress.


Language/framework implementations

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

Language
Status

Ready

Golang

In progress

PHP

Ruby

.Net

Kotlin

Framework
Status

Ready

Ready

NestJS

Container
Status

ECS sidecar

Kubernetes sidecar

Unsupported

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

  • GraphQL

  • gRPC

  • Async APIs


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

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

Contact us
Javascript/Typescript
NextJS
Redwood JS & Vercel
Get in touch
product map
Request support
get in touch
JavaScript / TypeScript
Request support
Request support
Request support
Request support
NextJS
RedwoodJS & Vercel
Request support
Request support
Request support