Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Apodini/Apodini
Apodini - A declarative, composable server-side Swift framework
https://github.com/Apodini/Apodini
Last synced: 3 months ago
JSON representation
Apodini - A declarative, composable server-side Swift framework
- Host: GitHub
- URL: https://github.com/Apodini/Apodini
- Owner: Apodini
- Created: 2020-06-23T21:45:56.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-22T14:22:37.000Z (10 months ago)
- Last Synced: 2024-07-05T13:46:11.326Z (4 months ago)
- Language: Swift
- Homepage: https://apodini.github.io/Apodini/
- Size: 6.13 MB
- Stars: 87
- Watchers: 10
- Forks: 11
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- License: LICENSES/Apache-2.0.txt
Awesome Lists containing this project
README
# Apodini
[](https://zenodo.org/badge/latestdoi/274515276)
[](https://codecov.io/gh/apodini/apodini)
[](https://github.com/Apodini/Apodini/actions/workflows/push.yml)
Apodini is a declarative, composable framework to build evolvable web services. It is part of a research project at the [TUM Research Group for Applied Software Engineering](https://ase.in.tum.de/schmiedmayer).
## Getting Started
### Installation
Apodini uses the Swift Package Manager:
Add it as a project-dependency:
```swift
dependencies: [
.package(url: "https://github.com/Apodini/Apodini.git", .branch("develop"))
]
```
Add the base package and all exporters you want to use to your target:
```swift
targets: [
.target(
name: "Your Target",
dependencies: [
.product(name: "Apodini", package: "Apodini"),
.product(name: "ApodiniREST", package: "Apodini"),
.product(name: "ApodiniOpenAPI", package: "Apodini")
])
]‚
```
### Hello World
Getting started is really easy:
```swift
import Apodini
import ApodiniREST
struct Greeter: Handler {
@Parameter var country: String?
func handle() -> String {
"Hello, \(country ?? "World")!"
}
}
struct HelloWorld: WebService {
var configuration: Configuration {
REST()
}
var content: some Component {
Greeter()
}
}
HelloWorld.main()
// http://localhost -> Hello, World!
// http://localhost?country=Italy -> Hello, Italy!
```
Apodini knows enough about your service to automatically generate OpenAPI docs. Just add the respective exporter:
```swift
import ApodiniOpenAPI
...
struct HelloWorld: WebService {
var configuration: Configuration {
REST {
OpenAPI()
}
}
...
}
// JSON definition: http://localhost/openapi
// Swagger UI: http://localhost/openapi-ui
```
With `Binding`s we can re-use `Handler`s in different contexts:
```swift
struct Greeter: Handler {
@Binding var country: String?
func handle() -> String {
"Hello, \(country ?? "World")!"
}
}
struct HelloWorld: WebService {
var configuration: Configuration {
REST {
OpenAPI()
}
}
var content: some Component {
Greeter(country: nil)
.description("Say 'Hello' to the World.")
Group("country") {
CountrySubsystem()
}
}
}
struct CountrySubsystem: Component {
@PathParameter var country: String
var content: some Component {
Group($country) {
Greeter(country: Binding($country))
.description("Say 'Hello' to a country.")
}
}
}
// http://localhost -> Hello, World!
// http://localhost/country/Italy -> Hello, Italy!
```
Apodini allows the developer to specify CLI-arguments that are passed to the `WebService`. The arguments can for example be used in `Configuration`:
```swift
struct HelloWorld: WebService {
@Flag(help: "Generate an OpenAPI documentation of the WebService.")
var generateOpenAPIDocs = false
var configuration: Configuration {
if(generateOpenAPIDocs) {
REST {
OpenAPI()
}
} else {
REST()
}
}
}
```
For further information on how to specify CLI-arguments see [https://github.com/apple/swift-argument-parser](https://github.com/apple/swift-argument-parser)
## Documentation
The framework is a research project to enable the development of evolvable web services. You can find technical documentation of the functionality in the [Apodini DocC documentation](https://github.com/Apodini/Apodini/tree/develop/Sources/Apodini/Apodini.docc)
## Contributing
Contributions to this project are welcome. Please make sure to read the [contribution guidelines](https://github.com/Apodini/.github/blob/main/CONTRIBUTING.md) first.
## License
This project is licensed under the MIT License. See [License](https://github.com/Apodini/Apodini/blob/reuse/LICENSES/MIT.txt) for more information.
## Code of conduct
For our code of conduct see [Code of conduct](https://github.com/Apodini/.github/blob/main/CODE_OF_CONDUCT.md)