开源项目常见问题解决方案

开源项目常见问题解决方案

typed-schema Typelevel http service definition DSL 项目地址: https://gitcode.com/gh_mirrors/ty/typed-schema

1. 项目基础介绍和主要编程语言

项目名称： Typed Schema

项目简介： Typed Schema 是一个基于 Scala 编程语言的 HTTP 服务定义领域特定语言（DSL），它可以将定义转换为 akka-http 路由和 OpenApi 3.0 定义。这个项目受到了 Haskell-servant 库的启发，旨在帮助开发者在使用现代 Scala 构建服务时满足一系列要求，例如服务实现与 OpenApi 3.0 规范的兼容性检查、服务定义与实现的分离、易于迁移到不同的效果/未来/任务实现，以及迁移到其他框架的便捷性。

主要编程语言： Scala

2. 新手常见问题及解决步骤

问题一：如何将项目添加到 Scala 项目中？

问题描述： 新手在使用这个项目时不知道如何将其添加到现有的 Scala 项目中。

解决步骤：

1. 打开您的 Scala 项目的 build.sbt 文件。
2. 在 libraryDependencies 添加以下依赖项（根据您使用的 Scala 版本选择其一）：

libraryDependencies ++= List(
  "ru.tinkoff" %% "typed-schema-swagger" % "latest version in badge",
  "ru.tinkoff" %% "typed-schema-akka-http" % "latest version in badge"
)

或者

libraryDependencies ++= List(
  "ru.tinkoff" %% "typed-schema-swagger" % "latest version in badge",
  "ru.tinkoff" %% "typed-schema-finagle-env" % "latest version in badge",
  "ru.tinkoff" %% "typed-schema-finagle-custom" % "latest version in badge"
)

3. 保存 build.sbt 文件并重新编译项目。

问题二：如何定义一个简单的 HTTP 服务？

问题描述： 初学者可能不清楚如何使用 Typed Schema 定义一个简单的 HTTP 服务。

解决步骤：

1. 在您的 Scala 代码中引入 Typed Schema 的相关库。
2. 定义一个服务接口，如下所示：

import ru.tinkoff.typedschema.http._
import ru.tinkoff.typedschema.http.server.akkahttp.AkkaHttpServer

object MyService {
  val routes = HttpService[IO] {
    GET / "hello" / "world" {
      Ok("Hello, World!")
    }
  }
}

3. 运行服务：

object Main extends App {
  implicit val system: ActorSystem = ActorSystem()
  implicit val materializer: Materializer = Materializer(system)
  implicit val executionContext: ExecutionContextExecutor = system.dispatcher

  val server = new AkkaHttpServer(MyService.routes)
  server.startServer("localhost", 8080)
}

问题三：如何生成 OpenApi 文档？

问题描述： 用户可能不清楚如何使用 Typed Schema 生成 OpenApi 文档。

解决步骤：

1. 确保您的项目已经添加了 typed-schema-swagger 依赖。
2. 在服务定义中，使用 SwaggerSupport 特质：

import ru.tinkoff.typedschema.http._
import ru.tinkoff.typedschema.http.swagger.SwaggerSupport

object MyService extends SwaggerSupport {
  val routes = HttpService[IO] {
    GET / "hello" / "world" {
      Ok("Hello, World!")
    }
  }

  val swaggerRoutes = swaggerRoutesFor(routes)
}

3. 在主程序中，将 Swagger 路由添加到服务器：

object Main extends App {
  // ... 省略其他代码 ...
  val server = new AkkaHttpServer(MyService.routes :+: MyService.swaggerRoutes)
  server.startServer("localhost", 8080)
}

通过上述步骤，新手可以更好地理解并使用 Typed Schema 项目来构建 HTTP 服务和生成 OpenApi 文档。

typed-schema Typelevel http service definition DSL 项目地址: https://gitcode.com/gh_mirrors/ty/typed-schema