README

Access Forem articles, users and other resources via API.

For a real-world example of Forem in action, check out DEV.

All endpoints that don't require authentication are CORS enabled.

Dates and date times, unless otherwise specified, must be in the RFC 3339 format.

Authentication

For more information, please visit https://dev.to/contact.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/bitween-software/dev-to-open-api-client.git"
    }
  ],
  "require": {
    "bitween-software/dev-to-open-api-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: api_key
$config = Bitween\DevTo\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Bitween\DevTo\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2
$config = Bitween\DevTo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2
$config = Bitween\DevTo\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Bitween\DevTo\Api\AdminConfigurationApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getConfig();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdminConfigurationApi->getConfig: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://dev.to/api

Models

• APIError
• ArticleCreate
• ArticleCreateArticle
• ArticleFlareTag
• ArticleIndex
• ArticleMe
• ArticleShow
• ArticleUpdate
• ArticleUpdateArticle
• ArticleVideo
• ArticleVideoUser
• Comment
• FollowedTag
• Follower
• Listing
• ListingCategory
• ListingCreate
• ListingCreateListing
• ListingUpdate
• ListingUpdateListing
• Organization
• PodcastEpisode
• PodcastEpisodePodcast
• ProfileImage
• ReadingList
• SharedOrganization
• SharedUser
• SiteConfig
• Tag
• User
• WebhookCreate
• WebhookCreateWebhookEndpoint
• WebhookIndex
• WebhookShow

Authorization

api_key

• Type: API key
• API key parameter name: api-key
• Location: HTTP header

oauth2

• Type: OAuth
• Flow: application
• Authorization URL: ``
• Scopes: N/A

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://dev.to/oauth/authorize
• Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

yo@dev.to

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 0.9.5
• Build package: org.openapitools.codegen.languages.PhpClientCodegen