isgasho / paperclip

WIP OpenAPI codegen for Rust.

Paperclip

Paperclip is a OpenAPI code generator for efficient type-safe compile-time checked HTTP APIs in Rust.

It's currently under active development and may not be ready for production use just yet.

You may be interested in:

• An overview.
• Supported features.
• Features being worked on.
• Examples.
• API documentation.

Developing locally

• Make sure you have rustup installed. cd into this repository and run make prepare to setup your environment.
• Now run make to build and run the tests.

Contributing

This project welcomes all kinds of contributions. No contribution is too small!

If you want to contribute to this project but don't know how to begin or if you need help with something related to this project, feel free to send me an email or ping me in Discord (same handle).

Code of Conduct

This project follows the Rust Code of Conduct.

License

Licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

FAQ

Why is this generating raw Rust code instead of leveraging procedural macros for compile-time codegen?

I don't think proc macros are the right way to go for REST APIs. We need to be able to see the generated code somehow to identify names, fields, supported methods, etc. With proc macros, you sorta have to guess.

This doesn't mean you can't generate APIs in compile-time. The only difference is that you'll be using build scripts instead and include! the relevant code. That said, we're using proc-macros for other things.

The error thrown at compile-time doesn't look like it's very useful. Isn't there a better way to do this?

None that I can think of, sadly.

New ideas here needed.