• Example Search
• Project Search

• Java
• Python
• JavaScript
• TypeScript
• C++
• Scala
• Blog

Project: endpoints4s (GitHub Link)

• endpoints4s-master
  • sttp
    • client
      • src
        • main
          • scala
            • endpoints4s
              • sttp
                • package.scala
                • client
                  • MuxEndpoints.scala
                  • package.scala
                  • Urls.scala
                  • BasicAuthentication.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
                  • JsonEntitiesFromCodecs.scala
        • test
          • scala
            • endpoints4s
              • sttp
                • client
                  • EnpointsTest.scala
                  • EndpointsDocs.scala
    • build.sbt
  • algebras
    • algebra
      • src
        • main
          • scala
            • endpoints4s
              • algebra
                • MuxEndpoints.scala
                • package.scala
                • Requests.scala
                • LowLevelEndpoints.scala
                • Urls.scala
                • BasicAuthentication.scala
                • Assets.scala
                • JsonEntities.scala
                • ChunkedEntities.scala
                • Tag.scala
                • Methods.scala
                • BuiltInErrors.scala
                • StatusCodes.scala
                • Endpoints.scala
                • Errors.scala
                • Responses.scala
              • package.scala
              • Semigroupal.scala
        • test
          • scala
            • endpoints4s
              • algebra
                • JsonTestApi.scala
                • MuxEndpointsDocs.scala
                • ChunkedEntitiesDocs.scala
                • TextEntitiesTestApi.scala
                • client
                  • BasicAuthTestSuite.scala
                  • TextEntitiesTestSuite.scala
                  • SumTypedEntitiesTestSuite.scala
                  • JsonTestSuite.scala
                  • ClientTestBase.scala
                  • EndpointsTestSuite.scala
                  • ChunkedJsonEntitiesTestSuite.scala
                  • JsonFromCodecTestSuite.scala
                • EndpointsDocs.scala
                • JsonEntitiesDocs.scala
                • ChunkedJsonEntitiesTestApi.scala
                • BasicAuthenticationTestApi.scala
                • JsonFromCodecTestApi.scala
                • SumTypedEntitiesTestApi.scala
                • server
                  • JsonEntitiesFromSchemasTestSuite.scala
                  • BasicAuthenticationTestSuite.scala
                  • TextEntitiesTestSuite.scala
                  • SumTypedEntitiesTestSuite.scala
                  • ServerTestBase.scala
                  • EndpointsTestSuite.scala
                  • ChunkedJsonEntitiesTestSuite.scala
                • EndpointsTestApi.scala
                • AssetsDocs.scala
                • JsonEntitiesFromSchemasTestApi.scala
    • algebra-circe
      • src
        • main
          • scala
            • endpoints4s
              • algebra
                • circe
                  • CirceCodec.scala
                  • JsonEntitiesFromCodecs.scala
        • test
          • scala
            • endpoints4s
              • algebra
                • circe
                  • ChunkedJsonEntitiesTestApi.scala
                  • JsonFromCirceCodecTestApi.scala
    • algebra-playjson
      • src
        • main
          • scala
            • endpoints4s
              • algebra
                • playjson
                  • JsonEntitiesFromCodecs.scala
        • test
          • scala
            • endpoints4s
              • algebra
                • playjson
                  • JsonFromPlayJsonCodecTestApi.scala
    • build.sbt
  • play
    • server-circe
      • src
        • main
          • scala
            • endpoints4s
              • play
                • server
                  • circe
                    • JsonEntities.scala
                    • Util.scala
                    • JsonEntitiesFromCodecs.scala
    • client
      • src
        • main
          • scala
            • endpoints4s
              • play
                • client
                  • MuxEndpoints.scala
                  • package.scala
                  • Urls.scala
                  • BasicAuthentication.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
                  • JsonEntitiesFromCodecs.scala
        • test
          • scala
            • endpoints4s
              • play
                • client
                  • EndpointsDocs.scala
                  • EndpointsTest.scala
    • server
      • src
        • main
          • scala
            • endpoints4s
              • play
                • package.scala
                • server
                  • MuxEndpoints.scala
                  • package.scala
                  • LowLevelEndpoints.scala
                  • Urls.scala
                  • PlayComponents.scala
                  • BasicAuthentication.scala
                  • Assets.scala
                  • JsonEntities.scala
                  • ChunkedEntities.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
        • test
          • resources
            • logback.xml
          • scala
            • endpoints4s
              • play
                • server
                  • ChunkedEntitiesDocs.scala
                  • EndpointsDocs.scala
                  • ServerInterpreterTest.scala
                  • EndpointsTest.scala
    • build.sbt
  • akka-http
    • client
      • src
        • main
          • scala
            • endpoints4s
              • akkahttp
                • package.scala
                • client
                  • MuxEndpoints.scala
                  • package.scala
                  • Urls.scala
                  • BasicAuthentication.scala
                  • JsonEntities.scala
                  • ChunkedEntities.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
                  • EndpointsSettings.scala
        • test
          • scala
            • endpoints4s
              • akkahttp
                • client
                  • ChunkedEntitiesDocs.scala
                  • AkkaHttpClientEndpointsJsonSchemaTest.scala
                  • AkkaHttpClientEndpointsTest.scala
                  • EndpointsDocs.scala
    • server
      • src
        • main
          • scala
            • endpoints4s
              • akkahttp
                • server
                  • MuxEndpoints.scala
                  • package.scala
                  • Urls.scala
                  • BasicAuthentication.scala
                  • JsonEntities.scala
                  • ChunkedEntities.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
        • test
          • scala
            • endpoints4s
              • akkahttp
                • server
                  • ChunkedEntitiesDocs.scala
                  • EndpointsJsonSchemaTest.scala
                  • EndpointsDocs.scala
                  • ServerInterpreterTest.scala
                  • EndpointsTest.scala
                  • EndpointsCodecsTestApi.scala
    • build.sbt
  • json-schema
    • json-schema-playjson
      • src
        • main
          • boilerplate
            • TuplesSchemas.scala.template
          • scala
            • endpoints4s
              • playjson
                • package.scala
                • JsonSchemas.scala
        • test
          • scala
            • endpoints4s
              • playjson
                • JsonSchemasOptionalFieldsTest.scala
                • JsonSchemasTest.scala
                • JsonSchemasDocs.scala
    • json-schema-circe
      • src
        • main
          • boilerplate
            • TuplesSchemas.scala.template
          • scala
            • endpoints4s
              • circe
                • package.scala
                • JsonSchemas.scala
        • test
          • scala
            • endpoints4s
              • circe
                • JsonSchemasOptionalFieldsTest.scala
                • JsonSchemasTest.scala
                • JsonSchemasDocs.scala
    • json-schema
      • src
        • main
          • boilerplate
            • TuplerAppend.scala.template
            • TuplesSchemas.scala.template
          • scala
            • endpoints4s
              • algebra
                • JsonSchemas.scala
                • NoDocsJsonSchemas.scala
              • Tupler.scala
              • Hashing.scala
              • Validated.scala
              • InvariantFunctor.scala
              • Codec.scala
        • test
          • scala
            • endpoints4s
              • algebra
                • JsonSchemasOptionalFieldsTest.scala
                • JsonSchemasDocs.scala
                • JsonSchemasFixtures.scala
              • HashingTest.scala
              • TuplerTests.scala
    • json-schema-generic
      • src
        • main
          • scala
            • endpoints4s
              • generic
                • package.scala
                • annotations.scala
                • JsonSchemas.scala
        • test
          • boilerplate
            • FakeTuplesSchemas.scala.template
          • scala
            • endpoints4s
              • generic
                • JsonSchemasTest.scala
                • JsonSchemasDocs.scala
    • build.sbt
  • LICENSE
  • project
    • build.properties
    • LocalCrossProject.scala
    • plugins.sbt
    • EndpointsSettings.scala
  • CONTRIBUTING.md
  • .editorconfig
  • xhr
    • client-circe
      • src
        • main
          • scala
            • endpoints4s
              • xhr
                • circe
                  • JsonEntities.scala
    • client-faithful
      • src
        • main
          • scala
            • endpoints4s
              • xhr
                • faithful
                  • MuxEndpoints.scala
                  • package.scala
                  • Endpoints.scala
    • client
      • src
        • main
          • scala
            • endpoints4s
              • xhr
                • future
                  • package.scala
                  • Endpoints.scala
                • MuxEndpoints.scala
                • package.scala
                • LowLevelEndpoints.scala
                • Urls.scala
                • BasicAuthentication.scala
                • Assets.scala
                • JsonEntities.scala
                • thenable
                  • MuxEndpoints.scala
                  • package.scala
                  • Endpoints.scala
                • Methods.scala
                • BuiltInErrors.scala
                • StatusCodes.scala
                • Endpoints.scala
        • test
          • scala
            • endpoints4s
              • xhr
                • future
                  • EndpointsDocs.scala
                • EndpointsTest.scala
    • build.sbt
  • build.sc
  • documentation
    • examples
      • cqrs
        • commands-endpoints
          • src
            • main
              • scala
                • cqrs
                  • commands
                    • CommandsEndpoints.scala
        • commands
          • src
            • main
              • scala
                • cqrs
                  • commands
                    • CommandsService.scala
                    • Meter.scala
                    • Commands.scala
            • test
              • resources
                • application.conf
              • scala
                • cqrs
                  • commands
                    • CommandsTest.scala
        • public-server
          • src
            • main
              • scala
                • cqrs
                  • publicserver
                    • QueriesClient.scala
                    • Router.scala
                    • BootstrapEndpoints.scala
                    • CommandsClient.scala
                    • PublicServer.scala
        • web-client
          • src
            • main
              • scala
                • cqrs
                  • webclient
                    • PublicEndpoints.scala
                    • Main.scala
        • circe-instant
          • src
            • main
              • scala
                • io
                  • circe
                    • java8
                      • time
                        • package.scala
        • README.md
        • infra
          • src
            • main
              • resources
                • application.conf
              • scala
                • cqrs
                  • infra
                    • Main.scala
            • test
              • scala
                • cqrs
                  • Test.scala
        • queries
          • src
            • main
              • scala
                • cqrs
                  • queries
                    • Queries.scala
                    • QueriesService.scala
        • queries-endpoints
          • src
            • main
              • scala
                • cqrs
                  • queries
                    • QueriesEndpoints.scala
        • public-endpoints
          • src
            • main
              • scala
                • cqrs
                  • publicserver
                    • PublicEndpoints.scala
                  • queries
                    • model.scala
      • authentication
        • src
          • main
            • scala
              • authentication
                • Usage.scala
                • Authentication.scala
          • test
            • scala
              • authentication
                • AuthenticationTest.scala
        • README.md
      • quickstart
        • client
          • src
            • main
              • scala
                • quickstart
                  • CounterClient.scala
                  • Usage.scala
                  • CounterClientFuture.scala
        • endpoints
          • src
            • main
              • scala
                • quickstart
                  • CounterEndpoints.scala
        • server
          • src
            • main
              • resources
                • application.conf
              • scala
                • quickstart
                  • CounterServer.scala
                  • CounterDocumentation.scala
                  • Main.scala
            • test
              • scala
                • quickstart
                  • CounterTest.scala
      • basic
        • http4s-server
          • src
            • main
              • scala
                • sample
                  • Api.scala
                  • Server.scala
        • client
          • src
            • main
              • scala
                • sample
                  • Api.scala
                  • Main.scala
        • akkahttp-server
          • src
            • main
              • scala
                • sample
                  • Api.scala
                  • Server.scala
        • play-server
          • src
            • main
              • resources
                • application.conf
              • scala
                • sample
                  • Api.scala
                  • play
                    • server
                      • DocumentedApi.scala
                  • Server.scala
                  • openapi
                    • DocumentedApi.scala
        • shared
          • src
            • main
              • scala
                • sample
                  • algebra
                    • DocumentedApi.scala
                  • JsonStreamingExample.scala
                  • AssetsAlg.scala
                  • ApiAlg.scala
      • documented
        • src
          • main
            • resources
              • application.conf
              • public
                • swagger-ui.css
                • index.html
            • scala
              • counter
                • Counter.scala
        • README.md
    • manual
      • src
        • paradox
          • comparison.md
          • guides.md
          • algebras
            • json-entities.md
            • mux-endpoints.md
            • assets.md
            • json-entities.plantuml
            • chunked-entities.md
            • json-schemas.md
            • endpoints.md
            • json-entities.svg
          • quick-start.md
          • snippets.css
          • index.md
          • algebras-and-interpreters.md
          • release-and-compatibility-notes.md
          • design.md
          • guides
            • authentication-flow.plantuml
            • custom-authentication.md
            • authentication-flow.svg
            • tupler.md
          • talks.md
          • use-cases.md
          • interpreters
            • http4s.md
            • play.md
            • play-json.md
            • sttp.md
            • akka-http.md
            • scalaj-http.md
            • openapi.md
            • scalajs-web.md
            • circe.md
        • graphviz
          • multiple-interpreters.gv
          • extensible-algebra.gv
          • interactions.gv
          • project-layout.gv
          • json-decision.gv
    • build.sbt
  • scalaj
    • client
      • src
        • main
          • scala
            • endpoints4s
              • scalaj
                • package.scala
                • client
                  • package.scala
                  • Requests.scala
                  • Urls.scala
                  • BasicAuthentication.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
                  • JsonEntitiesFromCodecs.scala
                  • Responses.scala
        • test
          • resources
            • application.conf
          • scala
            • endpoints4s
              • scalaj
                • client
                  • EndpointsDocs.scala
                  • EndpointsTest.scala
                  • JsonEntitiesFromCodecTest.scala
    • build.sbt
  • http4s
    • client
      • src
        • main
          • scala
            • endpoints4s
              • http4s
                • client
                  • Urls.scala
                  • BasicAuthentication.scala
                  • JsonEntities.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
        • test
          • scala
            • endpoints4s
              • http4s
                • client
                  • EndpointsDocs.scala
                  • Http4sClientEndpointsJsonSchemaTest.scala
    • server
      • src
        • main
          • scala
            • endpoints4s
              • http4s
                • package.scala
                • server
                  • package.scala
                  • Urls.scala
                  • BasicAuthentication.scala
                  • JsonEntities.scala
                  • Methods.scala
                  • BuiltInErrors.scala
                  • StatusCodes.scala
                  • Endpoints.scala
        • test
          • scala
            • endpoints4s
              • http4s
                • server
                  • EndpointsDocs.scala
                  • ServerInterpreterTest.scala
                  • EndpointsTestApi.scala
    • build.sbt
  • millbuild
    • xhrBuild.sc
    • openapiBuild.sc
    • playBuild.sc
    • akkahttp.sc
    • algebrasBuild.sc
    • scalajBuild.sc
    • common.sc
  • .travis.yml
  • README.md
  • .scalafmt.conf
  • sbt-assets
    • src
      • main
        • scala
          • assets
            • AssetsTasks.scala
    • project
      • build.properties
      • plugins.sbt
    • build.sbt
    • version.sbt
  • .jvmopts
  • ci
    • travis-key.pub
    • secrets.tar.enc
    • pubring.asc
  • build.sbt
  • openapi
    • build.sbt
    • openapi
      • src
        • main
          • boilerplate
            • endpoints
              • ujson
                • TuplesSchemas.scala.template
              • openapi
                • TuplesSchemas.scala.template
          • scala
            • endpoints4s
              • ujson
                • package.scala
                • codecs.scala
                • JsonSchemas.scala
              • openapi
                • MuxEndpoints.scala
                • package.scala
                • Requests.scala
                • Urls.scala
                • BasicAuthentication.scala
                • Assets.scala
                • JsonEntities.scala
                • JsonSchemas.scala
                • ChunkedEntities.scala
                • Methods.scala
                • BuiltInErrors.scala
                • model
                  • OpenApi.scala
                • StatusCodes.scala
                • Headers.scala
                • Endpoints.scala
                • Responses.scala
        • test
          • scala
            • endpoints4s
              • ujson
                • JsonSchemasOptionalFieldsTest.scala
                • JsonSchemasTest.scala
              • openapi
                • OneOfTest.scala
                • DescriptionsTest.scala
                • CoproductEncodingTest.scala
                • EndpointsDocs.scala
                • TitlesTest.scala
                • WebhooksTest.scala
                • SumTypedRequests.scala
                • EndpointsTest.scala
                • ReferencedSchemaTest.scala
                • JsonSchemasTest.scala
                • ExamplesTest.scala
                • ArraysTest.scala
                • ChunkedEntitiesTest.scala
  • .gitignore

endpoints

endpoints4s is a Scala library for defining communication protocols over HTTP between applications.

See the documentation to learn more.

Running the Examples

$ sbt
> ++2.13.2
> <example>/reStart

Where <example> can be either example-cqrs, example-documented or example-quickstart-server.

And then browse http://localhost:9000.

Contributing

See the open issues.

Sponsors

Bestmile supports engineering work on the project.

Support

JetBrains offers one Open Source license.

License

This content is released under the MIT License.