naptime-master
- naptime-testing
  - src
    - main
      - scala
        org
        coursera
        naptime
        actions
        RestActionTester.scala
        router2
        RouterTestHelpers.scala
        ResourceInjectionTest.scala
    - test
      - scala
        org
        coursera
        naptime
        NonNestedMacroTests.scala
        NestedMacroTestsHelper.java
        NestedMacroCourierTests.scala
        router2
        PlayNaptimeRouterIntegrationTest.scala
        NestedMacroTests.scala
        CustomRequestResponseMacroTests.scala
        NaptimeModuleTest.scala
        IdInferenceMacroTests.scala
        AuthMacroTest.scala
        AuthBuilderTest.scala
      - pegasus
        org
        coursera
        naptime
        InstructorId.courier
        couriertests
        ExpectedMergedCourse.courier
        SortOrder.courier
        Course.courier
        Instructor.courier
        Person.courier
  - build.sbt
- examples
  - src
    - main
      - resources
        application.conf
        logback.xml
        routes
      - scala
        services
        ApplicationTimer.scala
        Counter.scala
        resources
        CoursesResource.scala
        UserResource.scala
        PartnersResource.scala
        InstructorsResource.scala
        views
        graphiql.scala.html
        ResourceModule.scala
        stores
        PartnerStore.scala
        InstructorStore.scala
        CourseStore.scala
        controllers
        HomeController.scala
        Module.scala
        filters
        EnableDebuggingFilter.scala
        ExampleProjectFilters.scala
      - pegasus
        org
        coursera
        example
        InstructorId.courier
        CourseMetadata.courier
        User.courier
        PartnerId.courier
        DegreeCourseMetadata.courier
        Partner.courier
        AnyData.courier
        CertificateCourseMetadata.courier
        Course.courier
        CourseId.courier
        Instructor.courier
    - test
      - scala
        ApplicationSpec.scala
        IntegrationSpec.scala
  - README.md
  - build.sbt
  - .gitignore
- naptime-graphql
  - src
    - main
      - scala
        org
        coursera
        naptime
        ari
        graphql
        SangriaGraphQlContext.scala
        GraphqlSchemaProvider.scala
        resolvers
        NoopResolver.scala
        NaptimeResolver.scala
        controllers
        middleware
        SlowLogMiddleware.scala
        ResponseMetadataMiddleware.scala
        MetricsCollectionMiddleware.scala
        GraphQLController.scala
        filters
        DefaultFilters.scala
        Filter.scala
        models.scala
        QueryComplexityFilter.scala
        SangriaGraphQlSchemaBuilder.scala
        types
        NaptimeTypes.scala
        marshaller
        NaptimeMarshaller.scala
        schema
        FieldBuilder.scala
        NaptimeEnumField.scala
        exceptions.scala
        NaptimeRecordField.scala
        NaptimeResourceField.scala
        SchemaMetadata.scala
        NaptimeTopLevelResourceField.scala
        NaptimeResourceUtils.scala
        NaptimeUnionField.scala
        GraphQLRelation.scala
        SchemaErrors.scala
        NaptimePaginatedResourceField.scala
        models.scala
        NaptimePaginationField.scala
    - test
      - scala
        org
        coursera
        naptime
        ari
        graphql
        DefaultGraphqlSchemaProviderTest.scala
        helpers
        ArgumentBuilder.scala
        middleware
        UrlLoggingMiddlewareTest.scala
        controllers
        filters
        FilterTest.scala
        QueryComplexityFilterTest.scala
        models.scala
        schema
        NaptimePaginatedResourceFieldTest.scala
        NaptimeUnionFieldTest.scala
        FakeFetcherApi.scala
        NaptimeTopLevelResourceFieldTest.scala
        PrimitiveFieldTest.scala
        NaptimeResourceUtilsTest.scala
        NaptimeAnyDataFieldTest.scala
        TestExecutorHelper.scala
        NaptimeEnumFieldTest.scala
        engine
        UtilitiesTest.scala
  - build.sbt
- sonatype.sbt
- project
  - build.properties
  - NaptimeBuild.scala
  - NamedDependencies.scala
  - Sonatype.scala
  - plugins.sbt
- .travis.yml
- README.md
- naptime-models
  - src
    - main
      - scala
        org
        coursera
        naptime
        courier
        CourierSerializer.scala
        TypedDefinitions.scala
        StringKeyCodec.scala
        CourierFilters.scala
        CourierUtils.scala
        CourierImplicits.scala
        Exceptions.scala
        CourierFormats.scala
        SchemaInference.scala
        model
        Keyed.scala
        KeyFormat.scala
    - test
      - scala
        org
        coursera
        naptime
        courier
        SchemaInferenceTest.scala
        TestPositiveInt.scala
        TypedDefinitionsTest.scala
        CourierSerializerTest.scala
        CourierFiltersTest.scala
        CourierFormatsTest.scala
        CourierAssertions.scala
        CourierTestFixtures.scala
        StringKeyCodecTest.scala
        model
        KeyFormatTest.scala
      - pegasus
        org
        coursera
        naptime
        courier
        TestPositiveIntPairMapRecord.courier
        TestRecordWithDouble.courier
        TestPositiveInt.courier
        TestTypedDefinition.courier
        TestPositiveIntMoreComplex.courier
        TestPositiveIntComplex.courier
        TestUnion.courier
        TestPositiveIntPairUnion.courier
        TestPositiveIntPair.courier
  - build.sbt
- .scalafmt.conf
- naptime-sbt-plugin
  - src
    - main
      - scala
        org
        coursera
        naptime
        sbt
        StringEscaper.scala
        ScalaLibraryLocator.scala
        ScaladocSerializer.scala
        ScaladocExtractor.scala
        CommentRenderer.scala
        NaptimePlugin.scala
    - sbt-test
      - sbt-naptime
        simple
        src
        main
        resources
        application.conf
        logback.xml
        routes
        scala
        resources
        UserResource.scala
        Module.scala
        pegasus
        org
        coursera
        example
        User.courier
        test
        project
        plugins.sbt
        README.md
        build.sbt
  - scripted.sbt
  - build.sbt
- build.sbt
- NOTICE
- .gitignore
- LICENSE.txt
- naptime
  - src
    - main
      - scala
        org
        coursera
        naptime
        response.scala
        resources
        resources.scala
        RequestEvidence.scala
        actions
        RestActionBuilderTerminators.scala
        RestActionBodyBuilder.scala
        NaptimeSerializer.scala
        RestAction.scala
        package.scala
        RestActionBuilder.scala
        NaptimeActionSerializer.scala
        util
        DataMapUtils.scala
        RestActionCategoryEngine.scala
        RestActionCategoryEngine2.scala
        DefinedBodyTypeRestActionBuilder.scala
        utilities.scala
        ETag.scala
        path
        ParsedPathKey.scala
        PathKeyParser.scala
        ResourcePathParser.scala
        UrlParseResult.scala
        router2
        package.scala
        NaptimePlayRouter.scala
        NestingCollectionResourceRouter.scala
        ResourceRouter.scala
        MacroImpls.scala
        Router.scala
        AttributesProvider.scala
        CourierQueryParsers.scala
        CollectionResourceRouter.scala
        Types.scala
        ari
        package.scala
        engine
        Utilities.scala
        models.scala
        fetcher
        LocalFetcher.scala
        LocalSchemaProvider.scala
        NaptimeModule.scala
        exceptions
        exceptions.scala
        models.scala
        errors.scala
        access
        StructuredAccessControl.scala
        authorizer
        AuthorizeResult.scala
        Authorizer.scala
        combiner
        And.scala
        SuccessfulOf.scala
        EitherOf.scala
        AnyOf.scala
        authenticator
        ParseResult.scala
        HeaderAuthenticationParser.scala
        Decorator.scala
        combiner
        FirstOf.scala
        And.scala
        AuthenticationTransformer.scala
        AnyOf.scala
        Common.scala
        Authenticator.scala
        HeaderAccessControl.scala
      - pegasus
        org
        coursera
        naptime
        schema
        ParameterDataSchema.courier
        Resource.courier
        ArbitraryRecord.courier
        HandlerKind.courier
        ResourceKind.courier
        JsValue.courier
        Handler.courier
        ResourceSchemas.courier
        Parameter.courier
        ArbitraryBytesBody.courier
        TypeName.courier
        ResourceDataSchema.courier
        AuthOverride.courier
        Attribute.courier
        ArbitraryValue.courier
        GraphQLRelationAnnotation.courier
    - test
      - scala
        org
        coursera
        naptime
        actionCategoriesTests.scala
        resources
        NestingTests.scala
        actions
        SubDomainId.scala
        PlayJsonNaptimeSerializerTest.scala
        RecordTemplateNaptimeSerializerTest.scala
        DomainId.scala
        util
        Validators.scala
        DataMapUtilsTests.scala
        FlattenedFilteringJacksonDataCodecTest.scala
        RestActionCategoryEngine2Test.scala
        Slug.scala
        ResourceNameTest.scala
        JsonUtilitiesTest.scala
        RestContextTest.scala
        path
        ParsedPathKeyTest.scala
        CollectionResourcePathParserTest.scala
        PathKeyParserTest.scala
        router2
        CourierQueryParsersTest.scala
        NestingCollectionResourceRouterTest.scala
        QueryParserTests.scala
        NaptimePlayRouterTest.scala
        RouterTest.scala
        ResourceFieldsTest.scala
        TypesTest.scala
        ResourceTestImplicits.scala
        QueryStringParserTest.scala
        ETagTest.scala
        SchemaUtilsTest.scala
        access
        HeaderAccessControlCombinersTest.scala
        authenticator
        DecoratorTest.scala
      - pegasus
        org
        coursera
        naptime
        RecursiveModelBase.courier
        NestedChild.courier
        actions
        SubDomainId.courier
        CmlContentType.courier
        InstructorId.courier
        Domain.courier
        SessionId.courier
        TranslatableString.courier
        EnrollmentId.courier
        DomainId.courier
        PartnerId.courier
        CmlContent.courier
        Partner.courier
        Slug.courier
        ExpandedCourse.courier
        CoursePlatform.courier
        CourseQnA.courier
        SortOrder.courier
        Course.courier
        Instructor.courier
        IdWithIdField.courier
        RecursiveChild.courier
        ari
        graphql
        models
        StandardUnion.courier
        NewPlatformData.courier
        OldPlatformData.courier
        InstructorId.courier
        MergedPartner.courier
        MergedInstructor.courier
        SimpleEnum.courier
        MergedCourses.courier
        TypedDefinitionUnion.courier
        MergedCourse.courier
        PartnerId.courier
        PlatformSpecificData.courier
        MergedPointerEntity.courier
        AnyData.courier
        Coordinates.courier
        CourseId.courier
        RecordWithUnionTypes.courier
        MergedMultigetFreeEntity.courier
        StringLikeField.courier
  - build.sbt
- naptime-pegasus
  - src
    - main
      - java
        org
        coursera
        pegasus
        UnionVariantHandler.java
        FlatTypedDefinitionHandler.java
        TypedDefinitionHandler.java
        TypedDefinitionDataCoercer.java
        TypedDefinitionCodec.java
    - test
      - resources
        pegasusUnionWithUnrecognized.json
        typedDefinitionWithPrimitive.json
        flatTypedDefinition.pdsc
        pegasusUnion.json
        pegasusUnion.pdsc
        typedDefinitionWithPrimitive.pdsc
        typedDefinition.json
        pegasusUnionWithPrimitive.json
        complexWithoutNulls.json
        typedDefinition.pdsc
        flatTypedDefinitionWithOmitted.json
        pegasusComplex.json
        typedDefinitionWithUnrecognized.json
        flatTypedDefinitionWithUnrecognized.json
        flatTypedDefinition.json
        typedDefinitionComplex.json
        complex.pdsc
        typedDefinitionWithOmitted.json
        pegasusUnionWithOmitted.json
        passthroughExempt.pdsc
        complexWithNulls.json
        passthroughExempt.json
      - java
        org
        coursera
        pegasus
        TypedDefinitionCodecTest.java
  - README.md
  - build.sbt
- version.sbt

Naptime

Making REST APIs so easy, you can build them in your sleep!

Project Status: Alpha. Although Coursera has been using Naptime in production since 2013, and is responsible for nearly 100% of our traffic, expect a number of API and binary incompatibilities until we reach beta.

Coursera leverages interactive clients to provide a high quality learning experience. In practice, this means Javascript clients for the web, and native apps for iOS and Android. In order to avoid duplicated work, we re-use the same APIs across web and mobile clients. This has forced us to build generic, re-usable APIs. Naptime is the result of these efforts. Naptime helps server-side developers build canonical, RESTful, re-usable APIs.

Why Naptime?

We adopted Play! and Scala as part of our migration away from PHP & Python. We initially built APIs using the stock Play! APIs. Play!'s APIs are powerful and general, but we found we could trade off some of that power for a big gain in productivity and REST standardization. We believed that an opinionated, optimized framework could DRY out our code, and increase developer productivity. After a number of false starts, we built Naptime. Today, over 95% of new APIs at Coursera are built using Naptime. Developers like using Naptime because it helps them get their job done more quickly.

Naptime Principles

We've attempted to follow a few principles to help guide development. They are roughly:

Developer Productivity: Naptime is optimized for developer productivity above all else.
Canonical/Standardized: Naptime codifies a set of conventions to reduce ambiguity in generic REST APIs. It's much faster for both API and client developers to work on a myriad of products and features across our platform with these standardized APIs.
Type Safety: In our experience, due to the nature of our product, we've found that leveraging the compiler to catch bugs early is better for developers, in addition to taking advantage of IDEs (e.g. autocomplete) and other tooling.
Performance: If developers have to hack around performance problems, that ends up making more work not less. Naptime performance should be good, without compromising developer productivity.
Easy Learning: We strongly avoid DSLs and symbol operators. Additionally, despite leveraging advanced Scala capabilities (e.g. macros, path dependent types, the type-class pattern, etc.) to power the library, authoring a REST API should not require knowledge of quasiquotes or other advanced language features.

Using Naptime

To learn more about how to use naptime, check out our getting started guide!