Skip to content

Add OpenAPI templates for medium and large scale projects#20

Open
muumuu8181 wants to merge 1 commit intomainfrom
add-openapi-templates-2224369189124134972
Open

Add OpenAPI templates for medium and large scale projects#20
muumuu8181 wants to merge 1 commit intomainfrom
add-openapi-templates-2224369189124134972

Conversation

@muumuu8181
Copy link
Owner

This PR introduces OpenAPI templates to facilitate API design for medium and large-scale projects.

Changes

  • Created openapi_templates/medium:
    • Contains openapi.yaml, paths/, and components/.
    • Suitable for projects needing separation but low complexity.
  • Created openapi_templates/large:
    • Contains openapi.yaml, domains/, and shared/.
    • Follows DDD principles, allowing independent domain development.
  • Added openapi_templates/README.md:
    • Documentation on how to use and bundle the templates (e.g., with swagger-cli or redocly).

Verification

  • Verified file structure and content manually.
  • Confirmed JSON pointers and relative references work correctly.

PR created automatically by Jules for task 2224369189124134972 started by @muumuu8181

- Added `openapi_templates/medium/` with a flat structure for paths and components.
- Added `openapi_templates/large/` with a Domain-Driven Design (DDD) structure.
- Included `openapi_templates/README.md` explaining usage and bundling tools.

Co-authored-by: muumuu8181 <87556753+muumuu8181@users.noreply.github.com>
@google-labs-jules
Copy link
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant