DEV Community

Sudhanshu Ambastha
Sudhanshu Ambastha

Posted on

2 2 1 1 1

🚀 Major Release! Pokémon 3D API v1.0.0: Breaking Changes, Models, and More!

Hey Dev.to community!

I'm excited to announce the release of v1.0.0 of the Pokémon 3D API! This is a significant milestone, packed with breaking changes, a ton of new 3D models, and a complete overhaul of the documentation.

What's New in v1.0.0?

This isn't just a minor update – we've made some fundamental changes to how the API works, so if you're already using it, please pay close attention!

💥 Breaking API Changes:

The JSON response structure has been completely revamped. We've introduced a nested structure to better organize Pokémon forms.

Why the change? This new structure allows for more flexibility and easier access to different Pokémon forms (regular, shiny, etc.).

Migration is necessary! If your applications rely on the previous API structure, you'll need to update your parsing logic. Here's a quick example of the new format:

[
  {
    "id": 1,
    "forms": [
      {
        "name": "Bulbasaur",
        "model": "https://raw.githubusercontent.com/Sudhanshu-Ambastha/Pokemon-3D/main/models/opt/regular/1.glb",
        "formName": "regular"
      },
      {
        "name": "Shiny Bulbasaur",
        "model": "https://raw.githubusercontent.com/Sudhanshu-Ambastha/Pokemon-3D/main/models/opt/shiny/1.glb",
        "formName": "shiny"
      }
      // ... more forms
    ]
  },
  // ... more Pokémon objects
]
Enter fullscreen mode Exit fullscreen mode

📚 Comprehensive Documentation Overhaul:

We've completely rewritten the documentation to reflect the new API structure and provide more detailed explanations.

Key updates include:

  • Clearer explanations of the API endpoint and JSON response structure.
  • Updated Pokémon category and count information.
  • Practical Example: For a working example of how to use the new API, check out the opt.html file in the repository. This page is using the new API to display the optimized 3D models.

✨ Significant Model Additions:

We've added few new 3D models to the collection! Now you have even more Pokémon to display in your projects.

Why This Release Matters

This release marks a significant step forward in making Pokémon 3D models readily accessible for developers. Whether you're building a fan project, a game, or just experimenting with 3D graphics, this API provides a convenient way to integrate Pokémon models.

How to Get Started

  • Check out the updated documentation: documentation
  • Review the opt.html example: OPT.html
  • Update your code: If you're using a previous version, make sure to update your code to handle the new JSON structure.

We Need Your Feedback!

This is a community-driven project, and your feedback is invaluable. If you encounter any issues, have suggestions for improvements, or just want to share your projects, please let us know in the comments below! We're eager to see what you build.

Top comments (2)

Collapse
 
sudhanshuambastha profile image
Sudhanshu Ambastha •
Collapse
 
tuesdaysolutions profile image
Tuesday Solutions •

Nice