Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/propensive/nectary
Automatic OpenAPI endpoint generation
https://github.com/propensive/nectary
open-api open-api-client scala
Last synced: 25 days ago
JSON representation
Automatic OpenAPI endpoint generation
- Host: GitHub
- URL: https://github.com/propensive/nectary
- Owner: propensive
- Created: 2023-09-28T16:24:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-16T14:18:15.000Z (about 2 months ago)
- Last Synced: 2024-10-01T00:03:19.690Z (about 1 month ago)
- Topics: open-api, open-api-client, scala
- Language: Scala
- Homepage:
- Size: 659 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: .github/readme.md
- Contributing: .github/contributing.md
Awesome Lists containing this project
README
[](https://github.com/propensive/nectary/actions)
[](https://discord.com/invite/MBUrkTgMnA)# Nectary
__Automatic OpenAPI endpoint generation__
[OpenAPI](https://openapis.org/) provides a standardized, language-agnostic way
of specifying an HTTP API in either JSON or YAML. This specification provides
all the information necessary—such as endpoints, request parameters and types,
and response codes—to call the API. And it provides everything necessary for
the host language to present the HTTP API in a natively idiomatic way to the
programmer. It is this role that _Nectary_ plays.## Features
TBC
## Availability
## Getting Started
TBC
## Status
Nectary is classified as __embryotic__. For reference, Soundness projects are
categorized into one of the following five stability levels:- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity
- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns
- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement
- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later
- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipatedProjects at any stability level, even _embryonic_ projects, can still be used,
as long as caution is taken to avoid a mismatch between the project's stability
level and the required stability and maintainability of your own project.Nectary is designed to be _small_. Its entire source code currently consists
of 67 lines of code.## Building
Nectary will ultimately be built by Fury, when it is published. In the
meantime, two possibilities are offered, however they are acknowledged to be
fragile, inadequately tested, and unsuitable for anything more than
experimentation. They are provided only for the necessity of providing _some_
answer to the question, "how can I try Nectary?".1. *Copy the sources into your own project*
Read the `fury` file in the repository root to understand Nectary's build
structure, dependencies and source location; the file format should be short
and quite intuitive. Copy the sources into a source directory in your own
project, then repeat (recursively) for each of the dependencies.The sources are compiled against the latest nightly release of Scala 3.
There should be no problem to compile the project together with all of its
dependencies in a single compilation.2. *Build with [Wrath](https://github.com/propensive/wrath/)*
Wrath is a bootstrapping script for building Nectary and other projects in
the absence of a fully-featured build tool. It is designed to read the `fury`
file in the project directory, and produce a collection of JAR files which can
be added to a classpath, by compiling the project and all of its dependencies,
including the Scala compiler itself.
Download the latest version of
[`wrath`](https://github.com/propensive/wrath/releases/latest), make it
executable, and add it to your path, for example by copying it to
`/usr/local/bin/`.Clone this repository inside an empty directory, so that the build can
safely make clones of repositories it depends on as _peers_ of `nectary`.
Run `wrath -F` in the repository root. This will download and compile the
latest version of Scala, as well as all of Nectary's dependencies.If the build was successful, the compiled JAR files can be found in the
`.wrath/dist` directory.## Contributing
Contributors to Nectary are welcome and encouraged. New contributors may like
to look for issues marked
[beginner](https://github.com/propensive/nectary/labels/beginner).We suggest that all contributors read the [Contributing
Guide](/contributing.md) to make the process of contributing to Nectary
easier.Please __do not__ contact project maintainers privately with questions unless
there is a good reason to keep them private. While it can be tempting to
repsond to such questions, private answers cannot be shared with a wider
audience, and it can result in duplication of effort.## Author
Nectary was designed and developed by Jon Pretty, and commercial support and
training on all aspects of Scala 3 is available from [Propensive
OÜ](https://propensive.com/).## Name
A _nectary_ is the gland of a flower which produces nectar, for consumption by
bees, or in Latin, _apis_, which is a pun on "APIs".In general, Soundness project names are always chosen with some rationale,
however it is usually frivolous. Each name is chosen for more for its
_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no
bias towards names with positive or "nice" meanings—since many of the libraries
perform some quite unpleasant tasks.Names should be English words, though many are obscure or archaic, and it
should be noted how willingly English adopts foreign words. Names are generally
of Greek or Latin origin, and have often arrived in English via a romance
language.## Logo
The logo shows a droplet of nectar, with a slight hexagonal shape to the
droplet alluding to the cellular structure of a beehive.## License
Nectary is copyright © 2024 Jon Pretty & Propensive OÜ, and
is made available under the [Apache 2.0 License](/license.md).