Developing a piece Step-by Step

Hi Guys, I started this tutorial already, but it’s gonna take some time… maybe I’ll finish it this weekend, but I’m kinda busy.

I have made some quick contributions to AP, but this tutorial is way more time-consuming. I’m making it in Spanish and I will do my best to translate to English in an “understandable” way for y’all. Stay tuned
:slightly_smiling_face:

4 Likes

Take your time WizzyP, we appreciate you :muscle:

3 Likes

https://translate.google.com does a great job of spanish to english translation. Any update on your progress?

Exactly!! @Historian it’s what to do once you’ve forked the repository that needs to be documented. What is the environment setup that is needed? A step-by-step guide that gives the development process of a sample piece from beginning to testing to submission of the patch for acceptance.

1 Like

Hi y’all, I started making a video about this (I will add captions for every step of the development), but something went wrong on the AP’s side. Apparently the code for creating a new piece is broken. I’ve been kinda busy. But I’ll try again soon. If this is still broken, I’ll raise an issue to AP developers to fix that code (Create Action - Activepieces)

1 Like

@PFernandez98 I look forward to it.

It’s frustrating that they want to deflect to their documentation when the code to actually create the new piece it broken.

Hello @PFernandez98,

I hope this message finds you well. I noticed you’re experiencing issues while creating a new piece. Could you please provide more details about the errors you’re encountering?

Additionally, I recommend syncing your fork with the latest updates. This might resolve any compatibility issues and ensure you have the most recent improvements.

Thanks,
Kishan

Hi @kishanprmr now is working. I don’t remember what was the error, but is working now. TY

1 Like

Hi Everyone, at the end, I will share all the tutorials in here: AP Tutorials

I’ll be creating new posts every time I can. From “how to create a fork” to create the Pull Request in order to add your code (new pieces, actions, triggers, etc) to the main AP repository.

I added an RSS feed in case you want to follow the posts.

You can comment and ask for stuff there. You need a Github account for that, you can create one for free here: Join GitHub · GitHub

For Spanish speakers: I’ll translate the whole site to Spanish later (the site is gonna be multilingual)

PS: The site is open source. So you if you, reading this, are a Developer, you can contribute with new tutorials creating PRs on my own repository: GitHub - pfernandez98/ap-tutorials

Cheers.

@Bram @Peter_Michael_Zipper @ChaplainTIG @Momo @S_M @Cumonvip @mayar @Waughtermark @Historian @jerbecca

6 Likes

Adding the rest of people in this topic (I only can mention 10 people at a time):

@neilrjones @menacestudio @SSAdvisor

2 Likes

Awesome :man_mage:- excited for this!

Hey @PFernandez98
Did you ever publish that video with the caption?

Best way would be written. I could simply throw it in chatgpt and follow along instructions and get direct assistance whenever.

Also use chatgpt or claude for translation, more accurate

Yeah, throw it into GPT is getting toward the right idea.

Here is the best idea: OpenAPI/Swagger to Piece - It’s almost 2025, and almost TWO YEARS since GPT launched.

I think there should be a “magical” transformation from a Swagger spec to an ActivePieces Piece.
Here’s Perplexity’s take:
While Swagger/OpenAPI specifications remain industry standards for API documentation and design, automatically transforming these specs into ActivePieces Pieces isn’t currently a built-in feature. However, this idea has merit and could potentially streamline the process of creating custom Pieces.A more realistic approach for the ActivePieces community might be:

  1. Develop a tool or extension that uses Swagger/OpenAPI specs as a starting point to generate Piece templates or scaffolding.
  2. Create a workflow that assists developers in translating key elements from a Swagger spec (endpoints, parameters, response structures) into the ActivePieces Piece framework.
  3. Explore ways to leverage OpenAPI tooling, like Swagger Codegen, to automate parts of the Piece creation process, such as generating TypeScript interfaces or API client code.

While not a ‘magical’ transformation, these approaches could significantly reduce the manual work required to create Pieces from existing API specifications, making it easier for the community to expand ActivePieces’ integration capabilities.

I ran this on bolt.new - I am not sure whether Bolt quit finding errors to fix or I ran out of tokens first. [The project is public] (Swagger to ActivePieces Converter)

As I ran out of tokens, Bolt was offering to either convert the code to an npm module that could be installed globally and/or convert it to a web app, which is, of course, the more interesting option.

Update: DronaHQ has an Import Function for OpenAPI