Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benatespina/stackexchangeapiclient
PHP library for interacting with the Stack Exchange's version 2.2 REST API
https://github.com/benatespina/stackexchangeapiclient
php stackexchange stackexchange-api stackoverflow
Last synced: about 2 months ago
JSON representation
PHP library for interacting with the Stack Exchange's version 2.2 REST API
- Host: GitHub
- URL: https://github.com/benatespina/stackexchangeapiclient
- Owner: benatespina
- License: mit
- Created: 2014-09-05T08:47:13.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-09-15T14:21:44.000Z (over 7 years ago)
- Last Synced: 2024-10-12T11:15:54.365Z (2 months ago)
- Topics: php, stackexchange, stackexchange-api, stackoverflow
- Language: PHP
- Size: 371 KB
- Stars: 10
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
#  Stack Exchange v2.2 API Client
> PHP library for interacting with the [Stack Exchange](http://stackexchange.com/)'s version 2.2 REST API.
[](https://insight.sensiolabs.com/projects/1ebace1c-be1b-4a53-bef8-78d910aa2200)
[](https://travis-ci.org/benatespina/StackExchangeApiClient)
[](https://scrutinizer-ci.com/g/benatespina/StackExchangeApiClient/?branch=master)
[](https://packagist.org/packages/benatespina/stack-exchange-api-client)
[](https://packagist.org/packages/benatespina/stack-exchange-api-client)
[](https://packagist.org/packages/benatespina/stack-exchange-api-client)
## Requirements
PHP >= 7.1
## Installation
The easiest way to install this bundle is using [Composer][2]
```bash
$ composer require benatespina/stack-exchange-api-client
```
## Usage
If you check out the [API documentation](http://api.stackexchange.com/docs), you will see that there are some calls that
do not need authentication, but nevertheless there are other calls that need it so, this library allows to instantiate
StackExchange client with or without Authentication. Furthermore there two ways to use this library.
### Default usage
```php
user()->me();
$answers = $client->answer()->answers();
$answer = $client->answer()->createAnswer('the-question-id', 'This is my awesome answer!');
$client = StackExchange::withoutAuth();
// Throws an AuthenticationIsRequired exception
$profile = $client->user()->me();
$answers = $client->answer()->answers();
// Throws an AuthenticationIsRequired exception
$answer = $client->answer()->createAnswer('the-question-id', 'This is my awesome answer!');
```
### Full customized usage
```php
user()->me();
$answers = $client->answer()->answers();
$answer = $client->answer()->createAnswer('the-question-id', 'This is my awesome answer!');
// CUSTOM SERIALIZATION
//
// Instantiate the AnswerApi with custom serializer
// The following calls returns an answer model instance instead of a plain array
$answersApi = $client->answer(new ToModelSerializer(Answer::class));
$answers = $answersApi->answers();
$answer = $answersApi->createAnswer('the-question-id', 'This is my awesome answer!');
```
## Current status
The API has many methods, so the calls' implementation status are separated **by type** in the following files:
-  [Access Tokens](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/access_tokens.md)
-  [Answers](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/answers.md)
-  [Badges](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/badges.md)
-  [Comments](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/comments.md)
-  [Errors](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/errors.md)
-  [Events](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/events.md)
-  [Filters](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/filters.md)
-  [Flag Options](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/flag_options.md)
-  [Inbox Items](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/inbox_items.md)
-  [Network Users](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/network_users.md)
-  [Merge History](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/merge_history.md)
-  [Network Activity](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/network_activity.md)
-  [Notifications](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/notifications.md)
-  [Posts](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/posts.md)
-  [Privileges](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/privileges.md)
-  [Questions](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/questions.md)
-  [Question Timelines](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/question_timelines.md)
-  [Reputation](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/reputation.md)
-  [Reputation History](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/reputation_history.md)
-  [Revisions](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/revisions.md)
-  [Search Excerpts](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/search_excerpts.md)
-  [Sites](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/sites.md)
-  [Suggested Edits](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/suggested_edits.md)
-  [Tags](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/tags.md)
-  [Tag Scores](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/tag_scores.md)
-  [Tag Synonyms](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/tag_synonyms.md)
-  [Tag Wikis](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/tag_wikis.md)
-  [Top Tags](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/top_tags.md)
-  [Users](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/users.md)
-  [User Timeline](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/user_timeline.md)
-  [Write Permissions](https://github.com/benatespina/StackExchangeApiClient/blob/master/docs/write_permissions.md)
## Tests
This bundle is completely tested by **[PHPSpec][3], SpecBDD framework for PHP**.
Run the following command to launch tests:
```bash
$ vendor/bin/phpspec run -fpretty
```
## Contributing
This bundle follows PHP coding standards, so pull requests need to execute the Fabien Potencier's [PHP-CS-Fixer][4].
Furthermore, if the PR creates some not-PHP file remember that you have to put the license header manually. In order
to simplify we provide a Composer script that wraps all the commands related with this process.
```bash
$ composer run-script cs
```
There is also a policy for contributing to this bundle. Pull requests must be explained step by step to make the
review process easy in order to accept and merge them. New methods or code improvements must come paired with
[PHPSpec][3] tests.
## Credits
This library is created by:
>
**@benatespina** - [[email protected]](mailto:[email protected])
## Licensing Options
[](https://github.com/benatespina/StackExchangeApiClient/blob/master/LICENSE)
[2]: http://getcomposer.org
[3]: http://www.phpspec.net/en/stable/
[4]: http://cs.sensiolabs.org/