Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/absinthe-graphql/absinthe_phoenix
https://github.com/absinthe-graphql/absinthe_phoenix
Last synced: 11 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/absinthe-graphql/absinthe_phoenix
- Owner: absinthe-graphql
- License: mit
- Created: 2016-05-12T20:06:22.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T15:28:39.000Z (about 1 month ago)
- Last Synced: 2024-10-30T02:03:53.741Z (13 days ago)
- Language: Elixir
- Size: 158 KB
- Stars: 308
- Watchers: 15
- Forks: 82
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Absinthe.Phoenix
[](https://github.com/absinthe-graphql/absinthe_phoenix/actions?query=workflow%3ACI)
[](https://hex.pm/packages/absinthe_phoenix)
[](https://hexdocs.pm/absinthe_phoenix/)
[](https://hex.pm/packages/absinthe_phoenix)
[](https://opensource.org/licenses/MIT)
[](https://github.com/absinthe-graphql/absinthe_phoenix/commits/master)
This package integrates Absinthe subscriptions with Phoenix, so that you can use subscriptions via websockets.
For getting started guides on subscriptions see: https://hexdocs.pm/absinthe/subscriptions.html
For getting started guides on server side rendering see: https://hexdocs.pm/absinthe/subscriptions.html
## Installation
Install from [Hex.pm](https://hex.pm/packages/absinthe_phoenix):
For Phoenix 1.4, see the v1.5 branch: https://github.com/absinthe-graphql/absinthe_phoenix/tree/v1.5
### Phoenix 1.5
```elixir
def deps do
[
{:absinthe_phoenix, "~> 2.0.0"}
]
end
```
Note: Absinthe.Phoenix requires Elixir 1.11 or higher.
## Upgrading
See [CHANGELOG](./CHANGELOG.md) for upgrade steps between versions.
You may want to look for the specific upgrade guide in the [Absinthe documentation](https://hexdocs.pm/absinthe).
## Documentation
See "Usage," below, for basic usage information and links to specific resources.
- [Absinthe.Phoenix hexdocs](https://hexdocs.pm/absinthe_phoenix).
- For the tutorial, guides, and general information about Absinthe-related
projects, see [http://absinthe-graphql.org](http://absinthe-graphql.org).
## Related Projects
See the [GitHub organization](https://github.com/absinthe-graphql).
## Usage
You need to have a working Phoenix PubSub configured. Here is what the default looks like if you create a new Phoenix project:
```elixir
config :my_app, MyAppWeb.Endpoint,
# ... other config
pubsub_server: MyApp.PubSub
```
In your application supervisor add a line AFTER your existing endpoint supervision
line:
```elixir
[
# other children ...
MyAppWeb.Endpoint, # this line should already exist
{Absinthe.Subscription, MyAppWeb.Endpoint}, # add this line
# other children ...
]
```
Where `MyAppWeb.Endpoint` is the name of your application's phoenix endpoint.
In your `MyAppWeb.Endpoint` module add:
```elixir
use Absinthe.Phoenix.Endpoint
```
In your socket add:
```elixir
use Absinthe.Phoenix.Socket,
schema: MyAppWeb.Schema
```
Where `MyAppWeb.Schema` is the name of your Absinthe schema module.
That is all that's required for setup on the server.
For client side guidance see the guides.
## GraphiQL Usage
From within GraphiQL:
To use Absinthe.Phoenix from within GraphiQL, you need to tell GraphiQL about your websocket endpoint.
```elixir
forward "/graphiql", Absinthe.Plug.GraphiQL,
schema: MyAppWeb.Schema,
socket: MyAppWeb.UserSocket
```
## Community
The project is under constant improvement by a growing list of
contributors, and your feedback is important. Please join us in Slack
(`#absinthe-graphql` under the Elixir Slack account) or the Elixir Forum
(tagged `absinthe`).
Please remember that all interactions in our official spaces follow
our [Code of Conduct](./CODE_OF_CONDUCT.md).
## Contributing
Please follow [contribution guide](./CONTRIBUTING.md).
## Copyright and License
Copyright (c) 2016 Bruce Williams, Ben Wilson
Released under the MIT License, which can be found in [LICENSE.md](./LICENSE.md).