feat: Notebooks 2.0 // Backend // Auto generate Open API spec #46

[gaurangkudale]

Add Swagger Documentation to API

Description

This PR adds Swagger/OpenAPI documentation support to the Notebooks API service. This will provide interactive API documentation and a testing interface for developers.

Changes

• Added Swagger annotations to document the API (@title, @version, @description, etc.)
• Integrated http-swagger package to serve Swagger UI
• Added Swagger documentation endpoint at /api/v1/swagger/*
• Set up base configuration for API documentation:
  • Title: Notebooks API
  • Version: v1
  • Base Path: /api/v1
  • Default host: localhost:4000

Testing

After deploying, you can access the Swagger UI at:
http://localhost:4000/api/v1/swagger/index.html

Additional Notes

• Swagger JSON documentation will be available at /api/v1/swagger/doc.json
• Documentation will be automatically generated from the code annotations

[google-oss-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign kimwnasptd for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[thesuperzapper]

@gaurangkudale we will need to rebase this.

Also, I am a bit confused, is the swagger spec automatically generated, if not, how can we do that?

[ederign]

This PR was evolved to #206

@thesuperzapper we can close this one.