API Platform ActivityPub is a bundle for the API Platform framework and Symfony providing support for the ActivityPub protocol and for the ActivityStreams vocabulary.
The ActivityPub protocol is a decentralized social networking protocol. It provides a client to server API for creating, updating and deleting content, as well as a federated server to server API for delivering notifications and content.
API Platform ActivityPub allows to easily add support for ActivityPub to new or existing API Platform projects, while still being able to benefit from all API Platform features (yes, including Mercure, Vulcain and GraphQL!)
If it's not already done!
composer require api-platform/activity-pub
Install API Platform Schema Generator:
composer require --dev api-platform/schema-generator
Alternatively, you can download the PHAR version.
Then generate the entities:
../schema-generator/bin/schema generate src vendor/api-platform/activity-pub/build/schema.yaml
If you want to tweak the generated files, copy and adapt the provided configuration file.
The generation is a one time operation, then you can edit the entities to fit your need and remove api-platform/schema-generator
.
See the test configuration in tests/app/index.php
- MUST (security): Filter inbox and outbox according to current permissions
- MUST (security): Don't disclose BTO/BCC to other users
- MUST: Support other activities with side effects than
Create
- MUST: Handle the case when recipients are collections
- MAY: Liked Collection
- MAY: Likes Collection
- MAY: Shares Collection
- MAY: Shared Inbox Delivery
- MUST (security): Add support for HTTP signatures
- Add support for WebFinger
- See the TODOs in the source code
- Open source (and / or rewrite) the tests
- Add interfaces for
final
classes - Create a Symfony recipe
- Add support for MySQL and other DBMS (currently only Postgres is supported because of this custom DQL function)
Created by Kévin Dunglas. Sponsored by Les-Tilleuls.coop.