Install an API Client

JavaScript API Client

GitHub: DocSpring/docspring-javascript
NPM: docspring

Add docspring to your package.json

npm install docspring --save

Or with Yarn:

yarn add docspring

Ruby API Client

GitHub: DocSpring/docspring-ruby
RubyGems: docspring

Run the following command to install the docspring gem:

gem install docspring --no-document

Or add the following to your Gemfile:

gem "docspring"

Then run:

bundle install

Python API Client

GitHub: DocSpring/docspring-python
PyPi: docspring

Run the following command to install the docspring package:

pip install --upgrade docspring

easy_install --upgrade docspring

PHP API Client

GitHub: DocSpring/docspring-php
Packagist: docspring/docspring

Run the following command to install the docspring/docspring package:

composer require docspring/docspring

Or add the following to your composer.json:

    "require": {
        "docspring/docspring": "*"
    }

Then run:

composer install

Java API Client

GitHub: DocSpring/docspring-java
Maven: com.docspring/DocSpring

Maven

Add the following to the <dependencies> section in your pom.xml:

<dependency>
  <groupId>com.docspring</groupId>
  <artifactId>DocSpring</artifactId>
  <version>1.0.0</version>
</dependency>

Gradle

Add the following to the dependencies section in your build.gradle:

compile 'io.docspring:DocSpring:1.0.0'

C# API Client

GitHub: DocSpring/docspring-csharp
NuGet: DocSpring.Client

Install the DocSpring.Client package from NuGet:

Package Manager

PM> Install-Package DocSpring.Client

.NET CLI

dotnet add package DocSpring.Client

Paket CLI

paket add DocSpring.Client

If you would like DocSpring to support a new language, please send us an email at: [email protected]

We define our API endpoints and request/response schemas with an OpenAPI Specification (formerly known as Swagger.) We use openapi-generator to automatically generate our API clients.

Please view the OpenAPI Specification page for more information.

Getting Started